@Api:
作用在类上,用来标注该类具体实现内容。表示标识这个类是swagger的资源 。
参数:
- tags:可以使用tags()允许您为操作设置多个标签的属性,而不是使用该属性。
- description:可描述描述该类作用。
@ApiImplicitParam:
作用在方法上,表示单独的请求参数
参数:
3. name :参数名。
4. value : 参数的具体意义,作用。
5. required : 参数是否必填。
6. dataType :参数的数据类型。
7. paramType :查询参数类型,这里有几种形式:
8. 在这里我被坑过一次:当我发POST请求的时候,当时接受的整个参数,不论我用body还是query,后台都会报Body Missing错误。这个参数和SpringMvc中的@RequestBody冲突,索性我就去掉了paramType,对接口测试并没有影响
@ApiImplicitParams:
用于方法里面有多个@ApiImplicitParam
@ApiModel:
用于类,表示对类进行说明,用于参数用实体类接收;
@ApiModelProperty:
用于方法,字段 ,表示对model属性的说明或者数据操作更改
@ApiOperation:
用于方法,表示一个http请求的操作 。
@ApiResponse:
用于方法,描述操作的可能响应。
@ApiResponses:
用于方法,一个允许多个ApiResponse对象列表的包装器。
@ApiParam:
用于方法,参数,字段说明,表示对参数的添加元数据(说明或是否必填等)
@Authorization:
声明要在资源或操作上使用的授权方案。
@AuthorizationScope:
介绍一个OAuth2授权范围。
@ResponseHeader:
响应头设置,使用方法。
作者:都让你们叫老了
来源:CSDN
原文:https://blog.csdn.net/java_yes/article/details/79183804
版权声明:本文为博主原创文章,转载请附上博文链接!