swagger使用以及一些注解说明

@Api：作用于Conntroller类上
  value：字段说明
  description：描述
  tags：分组 (经常用到tags，例如如下，我只是给value，则默认应用了类名)

@ApiOperation:
  value：接口用途（必选） 直接在注解后括号内写，即value的值，会在swagger-ui里显示，具体示例如下
  notes：备注说明（可选）
  httpMethod：请求方式（可选）
  response：返回参数类型（可选）
  tags：接口分组名（可选）

@ApiImplicitParams:（可选，当描述多个@ApiImlicitParam时使用）,即描述多个参数的时候使用

   @ApiImplicitParam(

　　接口入参描述，本身可选，对应的子字段也可选。

　　name：参数属性命

　　value：参数说明

　　required：是否必传 true/false

　　paramType：请求参数的获取方式

　　　　header：@RequestHeader 从请求头获取

　　　　query：@RequestParam 从请求参数获取

　　　　path：@PathVariable 从请求的路径获取，这也是使用动态请求url的使用的注解

　　　　body:@RequestBody 使用此注解，可以选择接收参数为对象类型

　　　　form：极少使用，请求表单中获取

　　dataType：参数类型

　　defaultValue：参数默认值

)

@PathVariable的使用示例如下：

@ApiIgnore: 作用于接口入参参数列表，表示swagger忽略该入参

@ApiModelProperty:作用于入参实体对象的属性上（本身可选，对应子字段也全部可选）
  value：字段描述
  name：属性名字 
  dataType：属性类型 
  required：是否必传
  example：参数样例
  hidden：隐藏

@ApiResponses:(接口返回结果；可选，当描述多个@ApiResponse时候使用)
  @ApiResponse：（可选）
    code：HTTP请求返回码。（必选）
    message：返回信息。（必选）
    response：返回类型，需使用全类名。eg："com.xxx.dto.DemoRequestDTO.class"（可选）

原文：https://www.cnblogs.com/lin-bunny/p/12409439.html