那里有任何 Springfox 替代品吗？ [关闭]

Posted 2023-02-27

【中文标题】那里有任何 Springfox 替代品吗？ [关闭]

【英文标题】：Any Springfox alternatives out there? [closed]

【发布时间】：2020-03-16 02:55:24

【问题描述】：

过去两年，我使用 Springfox 开发 Spring Boot 应用程序。 Springfox 为您的 REST API 生成文档和测试 ui。这太棒了。

但实际上 Springfox 项目已经死了，不支持最新的 Spring。我有三个问题

有没有其他方法可以直接生成 Swagger UI？还有其他图书馆/项目吗？ 如何在 Spring Boot 项目中实现 swagger ui？ 也许我已经过时了，有没有比 Spring Boot 的招摇员工更好的选择？

【参考方案1】：

我自己还没有尝试过，但这看起来很有希望：

https://github.com/springdoc/springdoc-openapi

OpenAPI 3.0 是 Open API 2.0（有时称为 Swagger，尽管这实际上是围绕 Open API 的工具）的继承者。 不确定这个项目在定制方面提供了多少以及它有多成熟，但我想值得一试;-)

更新： 从版本 3 开始，Spring Fox 提供对 Open API 3 的支持。有关详细信息，请参阅release log。

【讨论】：

Springdoc-openapi 确实优于springfox，但是您的那句话“OpenAPI 是 Swagger 的继承者”实际上是错误的。 OpenAPI 是一个规范，Swagger 是一堆工具。见swagger.io/blog/api-strategy/…。

你是对的，当然。我已经更新了答案以澄清这种误解。

谢谢！我不介意你说“springdoc-openapi 是springfox 的继任者”，因为对我来说它看起来像。在我看来springfox 只是错过了火车。我们从 springfox 迁移到 springdoc-openapi 并且不打算回去，即使已经也支持 OpenAPI 3.0。

【参考方案2】：

Spring doc Open API 是未来的替代方案。

SpringDoc OpenAPI 支持 OAS 3.0 支持更多注释，例如不支持的@MatrixParam 在春狐。 Spring boot 2.2.x 仅适用于 springdoc。

参考以下链接

https://techsparx.com/software-development/openapi/spring-boot-rest-api-docs.html

【讨论】：

springfox 3.0.0 现在支持 spring-boot 2.2.x（实际上是这个版本的先决条件） - github.com/springfox/springfox/releases/tag/3.0.0

你的链接techsparx.com/software-development/openapi/…没有提到Springdoc。作者介绍了手动创建 OpenAPi 规范，然后第二种方法是从代码生成。他使用 Springfox 来做到这一点。

【参考方案3】：

https://github.com/RabiAPI/Evalon4J

这是一个用于生成java restful api文档的命令行工具

支持的框架

Spring MVC JAX-RS Swagger 2.0 注释 OpenAPI 3.0 注释 JSR303 Bean 验证

现在它可以将你的 api 导出为 markdown 格式。