Springfox

构建状态	覆盖率	代码分析

SonarCloud 分析

关于

了解更多关于该项目的信息，请访问 Springfox 官网 或者 http://springfox.github.io/springfox/

有用链接

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

开始使用

新项目

对于 Maven

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

对于 Gradle

  implementation "io.springfox:springfox-boot-starter:<版本>"

迁移自早期快照

Spring Boot 应用程序

注意：我们希望反馈来使此过程更好

1. 移除显式的 springfox-swagger2 依赖
2. 移除所有 @EnableSwagger2... 注解
3. 添加 springfox-boot-starter 依赖项
4. Springfox 3.x 去除了对 guava 和其他第三方库的依赖（还不是零依赖，仍然依赖 Spring 插件和 OpenAPI 库以获取注解和模型），所以如果你曾使用过 guava 的谓词/函数，它们需要转换为 Java 8 的功能接口。

从现有 2.x 版本迁移

Spring Boot 应用程序

注意：我们希望反馈来改善这一体验

1. 移除显式的 springfox-swagger2 依赖
2. 移除 @EnableSwagger2 注解
3. 添加 springfox-boot-starter 依赖
4. Springfox 3.x 去除了对 guava 和其他第三方库的依赖（还不是零依赖，取决于 Spring 插件和 OpenAPI 库的注解和模型），所以如果你使用了 guava 的谓词/函数，它们需要转换为 Java 8 的功能接口。
5. 如果你在使用 WebMvc 但尚未使用 @EnableWebMvc 注解，添加这个注解。

普通 Spring MVC

注意：我们希望能改进这个体验

1. 移除显式的 springfox-swagger2 依赖
2. 对于 Open API，添加 @EnableOpenApi （对于旧版本，添加 @EnableSwagger2WebMvc 或 @EnableSwagger2WebFlux）
3. 添加 springfox-oas 库
4. Springfox 3.x 去除了对 guava 和其他第三方库的依赖（还不是零依赖，取决于 Spring 插件和 OpenAPI 库的注解和模型），所以如果你使用了 guava 的谓词/函数，它们需要转换为 Java 8 的功能接口。

许可证

版权所有 2015 Marty Pitt - @martypitt，Dilip Krishnan - @dilipkrish，Adrian Kelly - @adrianbk。

根据 Apache 许可证 2.0 版授权（"许可"）； 您可以按照许可的规定使用此文件。除非根据许可另行同意，否则您不得以任何形式使用此文件。 您可以在 apache.org/licenses/LICENSE-2.0 获取许可的副本。

除非适用法律要求或书面同意，软件 根据许可提供的是“原样”基础， 没有任何明示或暗示的保证或条件。 参见许可以便了解特定的权限和限制条款。

许可证

此项目遵循的开源许可证信息可在上述链接中查看。