Swagger常用注解强调点说明

Swagger注解

常用注解：

• @Api()用于类-一般用于controller类；
  表示-标识这个类是swagger的资源，显示在文档中。

• @ApiOperation()用于方法-一般用于controller中的方法上；
  表示一个http请求的操作

• @ApiParam()用于方法中参数的说明-一般用于controller中的方法参数上；
  表示对参数的API说明或是否必填等
  备注：如果方法参数只有servlet的接口，比如request，response，那么无法使用该注解，
  因为接口并不显式展示入参的名称。

• @ApiModel()用于回执类/参数映射类
  表示对类进行说明，用于参数用实体类接收/接口响应的封装对象

• @ApiModelProperty()用于方法字段
  表示对model属性的说明或者数据操作更改

• @ApiIgnore()用于类，方法，方法参数
  表示这个方法或者类被忽略

• @ApiImplicitParam() 用于方法
  表示单独的请求参数 ，可以适用于servlet的接口，比如：request ，response 解决上面@ApiParam的问题。

• @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam