【记录】Swagger2 注解说明
2024-09-06 02:09:21
Swagger是一个用来管理项目接口的非常好用的第三方插件,
程序员只需要通过在接口代码上设置Swagger注解,
就可以在Swagger UI上进行查看与验证接口。
很大程度上节省了,接口文档的制作,与接口准确性的验证。
其中Swagger注解说明如下:
@Api:用在请求的类上,表示对类的说明
tags="说明该类的作用,可以在UI界面上看到的注解"
value="该参数没什么意义,在UI界面上也看到,所以不需要配置" @ApiOperation:用在请求的方法上,说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明" @ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值 @ApiResponses:用在请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类 @ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,
请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性
最新文章
- jQuery.rotate.js参数
- 玩转Windows服务系列——Windows服务小技巧
- TJI读书笔记14-闭包与回调
- 关于 SSV-ID: 4474 POC的分析和思考
- socket 中午吃的啥
- C. Anya and Smartphone
- Qt自定义菜单项
- apache .htaccess文件详解和配置技巧总结
- 纯Java代码 图片压缩
- Spring AOP的切入点表达式
- C++中虚拟继承
- c#, AOP动态代理实现动态权限控制(一)
- 探讨.NET Core数据进行3DES加密和解密问题
- vue--音乐播放器
- Android Material Design控件学习(二)——NavigationView的学习和使用
- JS 验证URL
- Java回顾之网络通信
- html input file accept
- ubuntu 安装微信开发者工具
- 快速排序——Java实现