Swagger API注解

@Api()：作用在类上，用来标注该类具体实现内容。表示标识这个类是swagger的资源

• 参数tags：可以使用tags允许您为操作设置多个标签的属性，而不是使用该属性。
• 参数value：可描述描述该类作用。

  @Api(value="用户controller",tags={"用户操作接口"})
  @RestController
  public class UserController {}

  

@ApiOperation()：用于方法，表示一个http请求的操作

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

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

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

  public User getUserInfo(@ApiParam(name="id",value="用户id") Long id,
  @ApiParam(name="username",value="用户名",required=true) String username)

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

• value–表示对象名
• description–描述

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

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

  @ApiModel(value="user对象",description="用户对象user")
  public class User implements Serializable{
  private static final long serialVersionUID = 1L;
  @ApiModelProperty(value="用户名",name="username",example="xingguo")
  private String username;
  @ApiModelProperty(value="状态",name="state",required=true)
   private Integer state;
   @ApiModelProperty(value="id数组",hidden=true)
   private String[] ids;
  //省略get/set
  }

@ApiIgnore()：用于类，方法，方法参数，表示这个方法或者类被忽略，可以不被swagger显示在页面上

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

• name–参数ming
• value–参数说明
• dataType–数据类型
• paramType–参数类型
• example–举例说明

  @ApiOperation("查询测试")
  @GetMapping("select")
  //@ApiImplicitParam(name="name",value="用户名",dataType="String", paramType = "query")
  @ApiImplicitParams({
  @ApiImplicitParam(name="name",value="用户名",dataType="string", paramType = "query",example="xingguo"),
  @ApiImplicitParam(name="id",value="用户id",dataType="long", paramType = "query")})
  public void select(){}

  

@ApiResponse：用于方法，描述操作的可能响应。