SpringBoot整合Swagger-UI实现自动生成API文档

最新推荐文章于 2025-03-03 09:52:17 发布

鹿谷門実

最新推荐文章于 2025-03-03 09:52:17 发布

阅读量266

点赞数

分类专栏： SpringBoot 文章标签： spring boot swagger

本文链接：https://blog.youkuaiyun.com/weixin_43517302/article/details/106340172

版权

本文档介绍了如何使用Swagger-UI在SpringBoot项目中自动生成API文档。Swagger是一个流行的API框架，通过注解如@Controller, @ApiOperation等，能够方便地生成Controller和接口的详细文档。在SpringBoot应用中，需要添加Swagger依赖，创建SwaggerConfig配置，并对Controller进行注解，最后启动应用并访问特定URL查看生成的文档。" 88040955,8402510,实现Windows风格的Ctrl+Shift多选功能,"['前端开发', 'JavaScript', '键盘事件', '多选操作']

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger-UI是HTML, Javascript, CSS的一个集合，可以动态地根据注解生成在线API文档，号称世界上最流行的API框架。官网：https://swagger.io/

常用注解

@Api(tags = "xxx模块说明") ：用于修饰Controller类，生成Controller相关文档信息
@ApiOperation("xxx接口说明") ：用于修饰Controller类中的方法，生成接口方法相关文档信息
@ApiModelProperty(value = "xxx属性说明",hidden = true) ：作用在类方法和属性上，hidden设置为true可以隐藏该属性，用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相关文档信息
@ApiParam("xxx参数说明") ：作用在参数、方法和字段上，类似@ApiModelProperty，用于修饰接口中的参数，生成接口参数相关文档信息

基本结构
在这里插入图片描述

步骤

1）在自己的springboot项目中添加Swagger依赖

<!--Swagger-UI API文档生产工具-->
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.7.0</version>
</dependency>
<

最低0.47元/天解锁文章