为什么使用Swagger 会让我变得懒惰?
当我年轻的时候,我把写伟大的文件作为我的使命。当您多次在文档工具之间切换时,您会发现通过在编写代码时直接编写注释来自动生成文档的便利性。而Swagger正是为此而正式诞生。
之前使用Swagger查找SpringBoot,添加Swagger总是需要以同样的方式引入依赖。
io.springfox springfox-swagger2 2.9.2 接下来,配置SwaggerConfig类,定义Docket等.所以大多数人都使用这种方法来访问Swagger,但是这个库太老了。该库的最新版本仍然是2023年6月。 Swagger 2.x 已经发布近两年了,但该库目前不支持2.0。不过,作者在2023 年8 月发表了一篇文章,描述了目前的进展。目前预计支持不会在一月份完成。那么为什么我对Swagger 2.x 如此挑剔呢?因为2.0 的实现标准是OpenAPI 3.0。更多详情请参见附录[3]。所以是时候放弃并改变方向了。
发现新世界- SpringdocSpringdoc 也是一个为您的Spring 项目自动生成API 文档的工具。
有哪些功能可以实现OpenAPI 3 规范? – 当然,因为它直接基于Swagger 2.xSpringBoot 1.x/2.x – 完全支持JSR-303 标准,无论是新旧标准- 接口对象A更标准化和更通用的Swagger UI 以及已定义的- 看起来更好。 OAutp – 您可能不需要使用Maven 项目来添加依赖项。您可以选择存储库中的最新版本作为您的项目版本。
请记住org.springdoc springdoc-openapi-ui 1.2.30。您无需执行任何操作,直接访问即可。
原始生成的文档可以在http://127.0.0.1:8080/swagger-ui.html 中找到。
世界上最好的高级使用说明
附加说明请参见附录[^6]下图是最终效果。
下载项目示例私信
综上所述,与Springfox 相比,我更推荐使用Springdoc。如今Springdoc版本更新社区更加活跃,项目也更加简单便捷。希望你也能输出好的文档!
附录[1] Swagger IO [2] Springdoc[3] OpenAPI 规范[4] Springfox[5] Swagger Core 2.X[6] Swagger 2.X 注解
本文和图片来自网络,不代表火豚游戏立场,如若侵权请联系我们删除:https://www.huotun.com/game/583852.html