Swagger2.X 注解

使用 Swagger2 时有几个常用注解需要掌握。

常用注解

1. @Api 标记

Api 用在类上，说明该类的作用。可以标记一个 Controller 类做为 swagger 文档资源，使用方式：
与 Controller 注解并列使用。 属性配置：

如：

@Api(tags = "product模块")
public class ProductController implements ProductFeign {
	
}

2. @ApiOperation 标记

ApiOperation：用在方法上，说明方法的作用，每一个 url 资源的定义,使用方式：

@ApiOperation(
          value = "Find purchase order by ID",
          notes = "",
          response = A.class,
          tags = {""})

与 Controller 中的方法并列使用。
属性配置：

如：

@ApiOperation(value = "/createCode", notes = "创建文件", response = ResultObj.class)
@RequestMapping(value = "/createCode")
public ResultObj createCode(
        @RequestParam(value = "tab_name", required = true) String tab_name
        , @RequestParam(value = "type", required = true) Integer type
        , @RequestParam(value = "includeSwagger", required = true) Boolean includeSwagger
        , @RequestParam(value = "moduleName", required = true) String moduleName
        , @RequestParam(value = "packageName", required = true) String packageName) {
    return ResultObj.getDefaultResponse(appTableService.listTable(tab_name, null));
}

3. @ApiImplicitParams、@ApiImplicitParam、@ApiParam 标记

@ApiImplicitParams

只有 value 一个属性，用来装多个 @ApiImplicitParam。

@ApiImplicitParam

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

paramType:

header-->请求参数的获取：@RequestHeader(代码中接收注解)    
query-->请求参数的获取：@RequestParam(代码中接收注解)    
path（用于restful接口）-->请求参数的获取：@PathVariable(代码中接收注解) 
body-->请求参数的获取：@RequestBody(代码中接收注解)    
form（不常用）)

如

@ApiOperation(value = "/createCode", notes = "创建文件", response = ResultObj.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "表名", value = "tab_name", paramType = "query", dataType = "String", required = true)
, @ApiImplicitParam(name = "生成代码类别参数", value = "type", paramType = "query", dataType = "Integer", required = true)
})
@RequestMapping(value = "/createCode")
    public ResultObj createCode(
        @RequestParam(value = "tab_name", required = true) String tabName
        , @RequestParam(value = "type", required = true, defaultValue = "-1") Integer type){return null;}

@ApiParam

用在接收参数中，指定一个请求参数的信息

@ApiParam 请求属性,使用方式：与 Controller 中的方法并列使用。

属性配置：

如

 public ResponseEntity<Order> getOrderById(
      @ApiParam(value = "ID of pet that needs to be fetched", allowableValues = "range[1,5]", required = true)
      @PathVariable("orderId") String orderId)

4. @ApiModel、@ApiModelProperty

@ApiModel

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

@ApiModelProperty

描述一个 model 的属性。

@Table(name = "app_table", schema = "", catalog = "")
@ApiModel(value = "物理表信息表", description = "当前数据库表信息")
public class AppTable implements Serializable {

    private static final long serialVersionUID = -1L;

    @Id
    @Column(name = "tab_name", unique = true)
    @ApiModelProperty(value = "表名主键")

5. @ApiResponses、@ApiResponse

@ApiResponses：响应集配置，使用方式：

 @ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") })

与 Controller 中的方法并列使用。 属性配置：

如：

 @RequestMapping(value = "/order", method = POST)
  @ApiOperation(value = "Place an order for a pet", response = Order.class)
  @ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") })
  public ResponseEntity<String> placeOrder(
      @ApiParam(value = "order placed for purchasing the pet", required = true) Order order) {
    storeData.add(order);
    return ok("");
  }

@ApiResponse：响应配置，使用方式：

@ApiResponse(code = 400, message = "Invalid user supplied")

与 Controller 中的方法并列使用。 属性配置：

在 SpringMvc 中的配置如下：

 @RequestMapping(value = "/order", method = POST)
  @ApiOperation(value = "Place an order for a pet", response = Order.class)
  @ApiResponses({ @ApiResponse(code = 400, message = "Invalid Order") })
  public ResponseEntity<String> placeOrder(
      @ApiParam(value = "order placed for purchasing the pet", required = true) Order order) {
    storeData.add(order);
    return ok("");
  }

6. ResponseHeader

响应头设置，使用方法

@ResponseHeader(name="head1",description="response head conf")

与 Controller 中的方法并列使用。 属性配置：