swagger2-实时生成接口文档

 

注解总结:

1. 1. @Api(tags="")

      1. 用在请求的类上，表示对类的说明
      2. tags"说明该类的作用，可以在UI界面上看到的注解"

   2. @ApiOperation(value="")

      1. 用在请求的方法上，说明方法的用途、作用
      2. value="说明方法的用途、作用"

   3. @ApiImplicitParams

      1. 用在请求的方法上，表示一组参数说明

      2. @ApiImplicitParam

         1. @ApiImplicitParam:指定一个请求参数的各个方面
         2. value：参数的汉字说明、解释
         3. required：参数是否必须传
         4. paramType：参数放在哪个地方
            1. header –> 请求头的获取：@RequestHeader
            2. query –> 请求参数的获取：@RequestParam
            3. path（用于restful接口）–> 请求路径变量的获取：@PathVariable
            4. body（不常用）
            5. form（不常用）
         5. dataType：参数类型，默认String，其它值dataType="Integer"
         6. defaultValue：参数的默认值

   4. @ApiResponses

      1. 用在请求的方法上，表示一组响应
      2. @ApiResponse
         1. 用在@ApiResponses中，一般用于表达一个错误的响应信息
         2. code：数字，例如400
         3. message：信息，例如"请求参数没填好"
         4. response：抛出异常的类

   5. @ApiModel:

      1. 主要有两种用途：
      2. 用于响应类上，表示一个返回响应数据的信息
      3. 入参实体：使用@RequestBody这样的场景， 请求参数无法使用@ApiImplicitParam注解进行描述的时候
      4. @ApiModelProperty:
         1. 用在属性上，描述响应类的属性