如何解决Spring Boot REST API:SpringDoc + OpenAPI 3 (springdoc-openapi-ui) 或 Swagger2 v3 (springfox-boot-starter)
有两种方法可以将 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 isue for config and annotation
问题是:Spring Boot 项目有什么理由让他们做出选择吗?
解决方法
在这种情况下,选择 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 支持规范的两个版本。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。