Swagger使用说明

swagger用于定义Api文档，swagger的使用主要在于注释的使用。

• 1.@Api 用在类上，说明该类的作用：
  

显示在这个位置

• 2.@RestController
  用在类上，表示是否可以接收HTTP的请求，相当于@ResponseBody ＋ @Controller合在一起的作用。

• 3.@RequestMapping
  处理请求的地址映射，可以用在类上，也可以用在方法中，用在类上，表示类中的所有响应请求的方法都是以该地址作为父路径，例如
  
  

• RequestMapping注解有六个属性，
  value： 指定请求的实际地址；
  method： 指定请求的method类型， GET、POST、PUT、DELETE等；
  consumes： 指定处理请求的提交内容类型（Content-Type），例如application/json, text/html;
  produces: 指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
  params： 指定request中必须包含某些参数值是，才让该方法处理。
  headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。

• 4.@GetMapping @PostMapping @DeleteMapping等

  @GetMapping("/regions/{region_id}")
  等价于
  @RequestMapping(value = "/regions/{region_id}", method = RequestMethod.GET)
  @PostMapping("/regions/{region_id}")
  等价于
  @RequestMapping(value = "/regions/{region_id}", method = RequestMethod.POST)
  

• 5.@ApiOperation 用在方法上，描述方法作用
  
  

• 6.@ApiImplicitParam： 用在方法中，指定一个请求参数的各个方面

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

  
  

• 7.@ApiResponse 用在方法中，一般用于表达一个错误的响应信息，有默认信息，可以不添加

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

• 8.@ApiModel
  描述一个实体类(model)的信息（这种一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）
  

• 9.@ApiModelProperty
  描述一个实体类(model)的属性(property)