扫码阅读
手机扫码阅读
Swagger3.0,你所不知道的新变化!
20 2024-11-02
我们非常重视原创文章,为尊重知识产权并避免潜在的版权问题,我们在此提供文章的摘要供您初步了解。如果您想要查阅更为详尽的内容,访问作者的公众号页面获取完整文章。
文章来源:
江南一点雨
扫码关注公众号
Springfox 3.0 版本更新摘要
松哥推出了原创的Spring Boot视频教程,同时分享了Springfox 3.0的最新变化。此版本支持OpenAPI(原Swagger规范),为REST API提供标准化描述。
OpenAPI 支持
OpenAPI是一种描述REST API的标准格式,内容包括接口操作、参数、响应、认证方法及联系信息等。更多详情可在GitHub查阅。
依赖简化
相较于2.9.2版本需添加两个依赖,3.0版本仅需要一个starter依赖(springfox-boot-starter),简化了配置。
接口地址变更
3.0版的接口地址从2.9.2版的"/v2/api-docs"和"/swagger-ui.html"变为"/v3/api-docs"和"/swagger-ui/index.html"。尝试访问旧地址将返回404错误。
注解更新
虽然旧注解可用,但3.0版引入了新注解如@EnableOpenApi,它导入OpenApiDocumentationConfiguration配置类。不过,在许多情况下,这个注解似乎并不是必需的。另外,一些旧注解已经移动到了不同的包,需要注意导包问题。例如,@ApiOperation现可用@Operation替代。
结语
文章总结了Swagger 3.0的重要更新,包括对OpenAPI的支持、依赖简化、接口地址变更和注解更新。松哥还提供了Spring Boot入门教程,讲解Swagger的使用方法。
想要了解更多内容?
文章来源:
江南一点雨
扫码关注公众号
江南一点雨的其他文章
加入社区微信群
与行业大咖零距离交流学习
软件研发质量管理体系建设
白皮书上线