swager中注解的用途
来源:互联网 发布:南京千米网络怎么样 编辑:程序博客网 时间:2024/05/29 17:44
/**
swagger2使用说明:
@Api:用在类上,说明该类的作用
@ApiOperation:用在方法上,说明方法的作用
@ApiIgnore:使用该注解忽略这个API
@ApiImplicitParams:用在方法上包含一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
paramType:参数放在哪个地方
header-->请求参数的获取:@RequestHeader
query-->请求参数的获取:@RequestParam
path(用于restful接口)-->请求参数的获取:@PathVariable
body(不常用)
form(不常用)
name:参数名
dataType:参数类型
required:参数是否必须传
value:参数的意思
defaultValue:参数的默认值
@ApiResponses:用于表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:描述一个model的属性
*/
阅读全文
0 0
- swager中注解的用途
- java反射注解的用途
- junit涉及到的注解,及其用途
- javascript中eval的用途
- javascript中eval的用途
- Java中Map的用途
- java中serialversionuid的用途
- DataSnap中DSHTTPLayer的用途
- shell中括号的用途
- Android中contentProvider的用途
- C++中_T的用途
- VB中DoEvents的用途
- BaseAdapter 中getItem 的用途
- Android中MimeType的用途
- java中serialversionuid的用途
- C#中反射的用途
- C++中_T的用途
- c++中:和::的用途
- Autofac tutorial 1
- 微信发送文本消息
- HDU5663 Hillan and the girl[莫比乌斯反演]
- Python基础
- Charles 使用简介
- swager中注解的用途
- BZOJ 2733 [HNOI2012]永无乡 Treap + 并查集
- leetcode 669. Trim a Binary Search Tree
- Spring IOC
- 微信支付 JAVA实现
- springCache使用
- Spring Cloud 熔断器
- 初始Maven1
- 【备忘】Java菜鸟到大牛学习路线培训教程