Swagger使用

Swagger使用

本文简单讲述Swagger在代码中的使用，列举出所常用的到注解。

• Swagger的简单描述
  Swagger UI可实现接口可视化，脱离写接口文档的痛苦和时间精力的消耗，可以避免去口头解说接口需要的参数和返回结果.当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑。类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。
• Swagger如何使用
  Swagger主要在Controller类上指定类描述，通过方法上注解指定接口描述、参数及参数描述。
• Swagger常用注解解析
  1、@Api 用在类上，说明该类的作用
  2、@Api(value = “UserController”, description = “用户相关api”)
  3、@ApiOperation 用在方法上，说明方法的作用
  @ApiOperation(value = “查找用户”, notes = “查找用户”, httpMethod = “GET”, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
  4、@ApiImplicitParams
  用在方法上包含一组参数说明
  5、@ApiImplicitParam
  用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
  paramType：参数放在哪个地方
  header–>请求参数的获取：@RequestHeader
  query–>请求参数的获取：@RequestParam
  path（用于restful接口）–>请求参数的获取：@PathVariable
  body（不常用）
  form（不常用）
  name：参数名
  dataType：参数类型
  required：参数是否必须传
  value：参数的意思
  defaultValue：参数的默认值

6、@ApiResponses
用于表示一组响应
7、@ApiResponse
用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如”请求参数没填好”
response：抛出异常的类

@ApiResponses(value = {
@ApiResponse(code = 400, message = “No Name Provided”)
})
8、@ApiModel
描述一个Model的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModel(value = “用户实体类”)

9、@ApiModelProperty
描述一个model的属性
@ApiModelProperty(value = “登录用户”)