SpringBoot 2.7.2 配置Swagger2---springfox实现
1.添加依赖
2.启动类添加注解
@EnableOpenApi3.修改路径
4.添加配置类
5.常用注解
Swagger2 | 描述 | 注解位置 |
---|---|---|
@Api | 用在请求的类上,表示对类的说明,tags="说明该类的作用,可以在UI界面上看到的注解" | Controller类之上 |
@ApiOperation | value="说明方法的用途、作用",notes="方法的备注说明" | 用在请求的方法上,说明方法的用途、作用 |
@ApiImplicitParams | (需要@ApiImplicitParam注解配合使用) | 用在请求的方法上,表示一组参数说明 |
@ApiImplicitParam | 指定一个请求参数的各个方面 name:参数名 value:参数的汉字说明、解释 required:参数是否必须传 paramType:参数放在哪个地方 | 用在@ApiImplicitParams注解中 |
@ApiResponses | (需要@ApiResponse注解配合使用) | 用在请求的方法上,表示一组响应 |
@ApiResponse | code:数字,例如400 message:信息,例如"请求参数没填好" response:抛出异常的类 | 用在@ApiResponses中,一般用于表达一个错误的响应信息 |
@ApiIgnore | 当作用在方法上时,方法将被忽略;作用在类上时,整个类都会被忽略;作用在参数上时,单个具体的参数会被忽略。 | 作用在方法上,类上,参数上 |
@ApiModel | 表示一个返回响应数据的信息 | 用于响应类上(DTO类) |
@ApiModelProperty | 描述响应类的属性 | DTO属性上 |
@ApiImplicitParam补充说明:
paramType:参数放在哪个地方
* header --> 请求参数的获取:@RequestHeader
* query --> 请求参数的获取:@RequestParam
* path(用于restful接口)--> 请求参数的获取:@PathVariable
* body(不常用)
* form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
6.分组及过滤设置
一个分组就是一个Docket Bean,想要开启过滤,就要用到select()。
分组的信息由ApiInfo Bean完成。
7.Swagger文档页码访问路径
http://localhost:8080/swagger-ui/
8.转载
转载两篇写的不错的文章
https://blog.csdn.net/weixin_42526326/article/details/119824857
【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步
· 阿里最新开源QwQ-32B,效果媲美deepseek-r1满血版,部署成本又又又降低了!
· SQL Server 2025 AI相关能力初探
· AI编程工具终极对决:字节Trae VS Cursor,谁才是开发者新宠?
· 开源Multi-agent AI智能体框架aevatar.ai,欢迎大家贡献代码
· Manus重磅发布:全球首款通用AI代理技术深度解析与实战指南