swagger常用注解说明

swagger常用注解说明

​ 关于和springboot的整合见swagger和springboot的整合.md

• Api

  Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源，使用方式：

  @Api(value = "Message-API", produces = "application/json")
  

• ApiOperation

  用在方法上，说明方法的作用，每一个url资源的定义,使用方式：

  @ApiOperation(value = "消息列表", notes = "消息列表")
  

• ApiModel

  描述一个Model的信息（这种一般用在post创建的时候使用)

  @ApiModel(value="user对象",description="用户对象user")
  public class User implements Serializable{
      @ApiModelProperty(value="用户名",name="username",example="xingguo")
      private String username;
  }
  

• ApiModelProperty

  描述一个model的属性。

  @ApiModelProperty(value="用户名",name="username",example="xingguo")
  

• ApiParam

  ApiParam请求属性,使用方式：也可使用在请求对象上。

  @ApiParam(value = "邮箱或用户名", required = true) @RequestParam("value") String value
  

• ApiResponses

  响应集配置，使用方式：

  @ApiResponses(value = {
              @ApiResponse(code = 200, message = "Successful — 请求已完成"),
              @ApiResponse(code = 500, message = "服务器不能完成请求")
  })
  

• ApiResponse

  响应配置，使用方式：

  @ApiResponse(code = "200",message = "Successful — 请求已完成")
  

• ResponseHeader

  响应头设置，使用方法

  @ResponseHeader(name="head1",description="response head conf")
  

• ApiImplicitParams

  用在方法上包含一组参数说明.

  @ApiImplicitParams(value = {
      @ApiImplicitParam(
          name = "Authorization",
          value = "用户Token",
          dataType = "string",
          paramType = "header",
          example = "Bearer 0b79bab50daca910b000d4f1a2b675d604257e42",
          required = true
  })
  

  ​