spring-boot - Spring 引导 REST API : SpringDoc + OpenAPI 3 (springdoc-openapi-ui) or Swagger2 v3 (springfox-boot-starter)

Question

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

• >

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

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

• >

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

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

还有migration issues for configuration and annotations .

问题是:对于 Spring Boot 项目，是否有任何理由在它们之间做出选择？

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

OpenApiConfig , pom.xml , Описание

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 支持这两个版本的规范。