swagger2常用注解
Posted 再见理想
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了swagger2常用注解相关的知识，希望对你有一定的参考价值。
本人常用注解说明：
@ApiOperation：用在方法上，说明方法的作用
- value: 表示接口名称
- notes: 表示接口详细描述
@ApiImplicitParams：用在方法上包含一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
- paramType：参数位置
- header 对应注解：@RequestHeader
- query 对应注解：@RequestParam
- path 对应注解: @PathVariable
- body 对应注解: @RequestBody
- name：参数名
- dataType：参数类型
- required：参数是否必须传
- value：参数的描述
- defaultValue：参数的默认值
@ApiResponses：用于表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
- code：状态码
- message：返回自定义信息
- response：抛出异常的类
@ApiIgnore: 表示该接口函数不对swagger2开放展示
以上这些就是我测试过的注解,并没有深究,有兴趣的,可以看看其它注解,或者源码,会比我描述的全很多,
对了,需要注意下,@ApiImplicitParam注解下的paramType属性,会影响接口的测试,如果设置的属性跟spring的注解对应不上,会获取不到参数,例如:paramType=path,函数内却使用@RequestParam注解,这样,可能会获取不到传递进来的参数,需要按照上面进行对应,将@RequestParam注解改为@PathVariable才能获取到对应的参数...