Spring Boot REST API: SpringDoc + OpenAPI 3 (springdoc-opena



有两种方法可以将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/设置-摇摆-3带弹簧靴-2-a7c1c3151545

配置和注释也存在迁移问题。

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

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

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

在这种情况下,选择Springdoc而不是Springfox有一个明显的原因。原因是,springdoc-openapi-ui是一个独立的库,而springfox-boot-starter则通过传递引入Spring依赖关系。在了解了POM的外观之后,Springfox为许多Spring项目提供了包装器。同样对于Swagger UI,您需要对Springfox进行额外的依赖。

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

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

最新更新