Swagger相关注解解读

• @Api

用在类上，说明该类的作用

@Api(value = "https://blog.yeahoo.top/userController", description = "用户相关api")

• @ApiOperation

用在方法上，说明方法的作用

@ApiOperation(value = "https://blog.yeahoo.top/getUser", notes = "查找用户", httpMethod = "GET", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)

• @ApiImplicitParams

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

• @ApiImplicitParam

用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

    paramType：参数放在哪个地方
    header–>请求参数的获取：@RequestHeader
    query–>请求参数的获取：@RequestParam
    path（用于restful接口）–>请求参数的获取：@PathVariable
    body（不常用）
    form（不常用）
    name：参数名
    dataType：参数类型
    required：参数是否必须传
    value：参数的意思
    defaultValue：参数的默认值

@ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "https://blog.yeahoo.top/id", required = true, dataType = "Long", paramType = "path"), })

• @ApiResponses

用于表示一组响应

• @ApiResponse

用在@ApiResponses中，一般用于表达一个错误的响应信息

    code：数字，例如400
    message：信息，例如”请求参数没填好”
    response：抛出异常的类

    @ApiResponses(value = https://blog.yeahoo.top/{  
              @ApiResponse(code = 400, message ="No Name Provided")  
      })

• @ApiModel

描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModel(value = "https://blog.yeahoo.top/userModel")

• @ApiModelProperty

描述一个model的属性

@ApiModelProperty(value = "https://blog.yeahoo.top/user")