Spring Boot REST API：SpringDoc + OpenAPI 3 (springdoc-openapi-ui) 或 Swagger2 v3 (springfox-boot-starter)

Question

有两种方法可以将 OpenAPI 3 添加到 Spring Boot 项目。

\n

\n
• \n

  <groupId>org.springdoc</groupId>\n<artifactId>springdoc-openapi-ui</artifactId>\n

  \n
\n

\n

https://www.dariawan.com/tutorials/spring/documenting-spring-boot-rest-api-springdoc-openapi-3/

\n

\n
• \n

  <groupId>io.springfox</groupId>\n<artifactId>springfox-boot-starter</artifactId>\n

  \n
\n

\n

https://medium.com/@hala3k/setting-up-swagger-3-with-spring-boot-2-a7c1c3151545

\n

还有配置和注释的迁移问题。

\n

问题是：对于 Spring Boot 项目，有什么理由在它们之间做出选择吗？

\n

更新：迁移到 OpenAPI 3。不太难:)也许会有帮助：

\n

OpenApiConfig ,\n pom.xml ,\n \xd0\x9e\xd0\xbf\xd0\xb8\xd1\x81\xd0\xb0\xd0\xbd\xd0\xb8\xd0\xb5

\n

Answer 1

在这种情况下，选择 Springdoc 而不是 Springfox 有一个明显的原因。原因是，springdoc-openapi-ui它是一个独立的库，同时springfox-boot-starter以传递方式引入 Spring 依赖项。了解了 POM 的外观后，Springfox 为许多 Spring 项目提供了包装器。另外，对于 Swagger UI，您需要 Springfox 的额外依赖项。

因此，使用 Springdoc 可以让您更好地控制 Swagger 集成，这是可选的，以防您想要使用 Spring REST Docs 这样的静态文档框架

就提到的迁移指南而言，它是用于将 Springfox 2.x 项目迁移到 Springdoc 的。Springdoc 支持 OpenAPI 3.x 而不是 2.x，而 Springfox 支持这两个版本的规范。