Swagger常用注解
Posted zxh06820
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Swagger常用注解相关的知识，希望对你有一定的参考价值。
Swagger注解：
@Api： 修饰整个类，描述Controller的作用
@ApiOperation： 描述一个类的一个方法，或者说一个接口
@ApiParam： 单个参数描述
@ApiModel： 用对象来接收参数
@ApiModelProperty： 用对象接收参数时，描述对象的一个字段
@ApiResponse： HTTP响应其中1个描述
@ApiResponses： HTTP响应整体描述
@ApiIgnore： 使用该注解忽略这个API
@ApiError ： 发生错误返回的信息
@ApiImplicitParam： 一个请求参数
@ApiImplicitParams： 多个请求参数
@ApiImplicitParam属性：
属性 取值 作用
paramType 查询参数类型
path 以地址的形式提交数据
query 直接跟参数完成自动映射赋值
body 以流的形式提交 仅支持POST
header 参数在request headers 里边提交
form 以form表单的形式提交 仅支持POST
dataType 参数的数据类型 只作为标志说明，并没有实际验证
Long
String
name 接收参数名
value 接收参数的意义描述
required 参数是否必填
true 必填
false 非必填
defaultValue 默认值
以上是关于Swagger常用注解的主要内容，如果未能解决你的问题，请参考以下文章