扫码阅读
手机扫码阅读
Spring Boot 整合 Swagger3 指北
58 2024-11-28
我们非常重视原创文章,为尊重知识产权并避免潜在的版权问题,我们在此提供文章的摘要供您初步了解。如果您想要查阅更为详尽的内容,访问作者的公众号页面获取完整文章。
文章来源:
江南一点雨
扫码关注公众号
松哥正在录制一个采用Spring Boot和Vue3技术栈的TienChin项目视频,该项目包含多种技术,旨在帮助小伙伴们一起完成一个超过90%完成率的项目。
尽管Swagger已经更新到3,但之前的版本在Spring Boot中依旧可以使用。然而,从Spring Boot 2.6开始,老版本的Swagger将不再支持,因此本文介绍了如何在Spring Boot 2.7.1中使用Swagger 3。
- 依赖:创建Spring Boot项目时,只需引入一个Swagger3依赖io.springfox:springfox-boot-starter:3.0.0,这与Swagger2时代需要的两个依赖相比已大为简化。
- 配置:在启动类上添加@EnableSwagger2和@EnableOpenApi注解以开启Swagger,然后通过访问
http://localhost:8080/swagger-ui/index.html
即可查看Swagger文档。还可以对Swagger页面进行定制,如设置网站基本信息,接口位置等。 - 接口配置:使用@Api, @ApiOperation, 和@ApiImplicitParam等注解来描述Controller功能、方法作用和参数说明。同时需要注意@ApiImplicitParam注解不能替代@RequestParam(required = true)来强制要求参数。
- 在Security中的配置:如果项目中集成了Spring Security,需在配置类中为Swagger相关文件和接口放行,以免被拦截。
通过以上步骤,可以实现Swagger文档的生成和自定义,并确保在有Spring Security集成的情况下也可访问Swagger文档。松哥邀请小伙伴们访问TienChin项目配套视频,共同提高项目完成率。
想要了解更多内容?
文章来源:
江南一点雨
扫码关注公众号
江南一点雨的其他文章
加入社区微信群
与行业大咖零距离交流学习
软件研发质量管理体系建设
白皮书上线