【问题标题】:Spring Boot REST API: SpringDoc + OpenAPI 3 (springdoc-openapi-ui) or Swagger2 v3 (springfox-boot-starter)Spring Boot REST API:SpringDoc + OpenAPI 3 (springdoc-openapi-ui) 或 Swagger2 v3 (springfox-boot-starter)
【发布时间】:2021-03-29 12:04:11
【问题描述】:

有两种方法可以将 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 项目有什么理由在它们之间做出选择吗?

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

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

【问题讨论】:

  • springdoc 是一个更易于管理的项目。如果您在 Github 上发布查询,您将获得查询支持

标签: spring-boot swagger springfox springdoc-openapi-ui


【解决方案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 支持这两个版本的规范。

【讨论】:

    猜你喜欢
    • 2022-12-06
    • 2020-04-02
    • 2020-12-18
    • 1970-01-01
    • 2022-12-08
    • 2020-06-25
    • 1970-01-01
    • 2020-05-12
    • 2022-10-25
    相关资源
    最近更新 更多