Swagger常用注解

用于controller类上的注解

@Api  说明：协议集描述（比如：@Api（value=“借款接口服务集合”，tags={“借款接口”}））

 

用于方法上的：

@ApiOperation  比如：@ApiOperation（value=“获取客户最近的借款信息”，tags={“借款接口”}，notes=“获取客户的最近借款信息”）

 

@Api（）用于类：表示标识这个类是swagger的资源

@ApiOperation（）用于方法：表示一个http请求的操作

@ApiParam（）：用于方法，参数，字段说明：表示对参数的添加元数据（说明或是否必填等）

@ApiModel（）用于类：表示对类进行说明，用于参数用实体类接收

@ApiModelProperty（）用于方法，字段：表示对model属性的说明或者是数据操作更改

@ApiIgnore（）用于类，方法，方法参数：表示这个方法或者类被忽略

@ApiImplicitParam（）用于方法：表示单独的请求参数

@ApiImplicitParams（）用于方法，包含多个@ApiImplicitParam

 

具体使用举例说明：

@Api（）：用于类；表示这个类是swagger的资源

tags-表示说明  value-也是说明，可以使用tags替代  但是tags如果有多个值，会生成对个list

@ApiOperation（）：用于方法；表示一个HTTP请求的操作

Value用于方法的描述  notes：用于提示内容  tags可以重新分组（视情况而用）

@ApiParam（）用于方法，参数，字段说明；表示对参数的添加元数据（说明是否必填等）

Name：参数名  value：参数说明  required：是否必填

@ApiModel（）用于类：表示对类进行说明，用于参数用实体类接收

Value：表示对象名  description：描述 这些都可以省略

@ApiModelProperty（）：用于方法，字段；表示对model属性的说明或者是数据操作的更改

Value-字段说明  name-重写属性名字 dataType-重写属性类型   required-是否必填   example-举例说明   hidden-隐藏

 

@ApiIgnore（）用于类或者方法上，可以不被swagger显示在页面上

@ApiImplicitParam（）；用于方法  表示单独的请求参数