springfox

春狐

构建状态	覆盖范围	代码分析

声纳云

关于

有关该项目的更多信息，请访问 Springfox 网站或 http://springfox.github.io/springfox/

有用的链接

• 参考文档
• 示例存储库
• 贡献指南
• 核心贡献者
• 开发与贡献指南
• 变更日志
• 开发环境
• 发布说明

入门

对于新项目

对于Maven

< dependency >
    < groupId >io.springfox</ groupId >
    < artifactId >springfox-boot-starter</ artifactId >
    < version >3.0.0</ version >
</ dependency >

对于摇篮

  implementation " io.springfox:springfox-boot-starter:<version> " 

从早期快照迁移

Spring引导应用程序

注意：希望得到反馈以使其变得更好

1. 删除对springfox-swagger2显式依赖
2. 删除任何@EnableSwagger2...注释
3. 添加springfox-boot-starter依赖
4. Springfox 3.x 删除了对 guava 和其他第 3 方库的依赖（还不是零依赖！依赖于 spring 插件和用于注释和模型的开放 api 库），因此如果您使用 guava 谓词/函数，则需要转换为 java 8 函数接口。

从现有 2.x 版本迁移

Spring引导应用程序

注意：希望得到反馈以使其变得更好

1. 删除对springfox-swagger2显式依赖
2. 删除@EnableSwagger2注释
3. 添加springfox-boot-starter依赖
4. Springfox 3.x 删除了对 guava 和其他第 3 方库的依赖（还不是零依赖！依赖于 spring 插件和用于注释和模型的开放 api 库），因此如果您使用 guava 谓词/函数，则需要转换为 java 8 函数接口
5. 如果您正在使用 WebMvc 但尚未使用@EnableWebMvc注解，请添加此注解。

常规 spring mvc

注意：希望得到反馈以使这种体验变得更好

1. 删除对springfox-swagger2显式依赖
2. 添加@EnableOpenApi用于开放API（以及@EnableSwagger2WebMvc或@EnableSwagger2WebFlux用于旧版本）
3. 添加了springfox-oas库
4. Springfox 3.x 删除了对 guava 和其他第 3 方库的依赖（还不是零依赖！依赖于 spring 插件和用于注释和模型的开放 api 库），因此如果您使用 guava 谓词/函数，则需要转换为 java 8 函数接口

执照

版权所有 2015 马蒂·皮特 - @martypitt、迪利普·克里希南 - @dilipkrish、阿德里安·凯利 - @adrianbk、

根据 Apache 许可证 2.0 版（“许可证”）获得许可；除非遵守许可证，否则您不得使用此文件。您可以在 apache.org/licenses/LICENSE-2.0 获取许可证副本

除非适用法律要求或书面同意，否则根据许可证分发的软件均按“原样”分发，不带任何明示或暗示的保证或条件。请参阅许可证，了解许可证下管理权限和限制的特定语言。

执照