swagger注解类说明

大家好，欢迎来到IT知识分享网。

讲解内容

1. swagger常用到的注解的解释
2. SpringMvc中控制层类中使用这些注解

swagger常用到的注解的解释

在pom.xml文件中添加包依赖：swagger-annotations-1.5.10.jar

所有注解：

常用到的注解有：

• Api
• ApiModel
• ApiModelProperty
• ApiOperation
• ApiParam
• ApiResponse
• ApiResponses
• ResponseHeader

Api 标记一个Controller类做为swagger 文档资源

使用方式：

@Api(value = "/user", description = "Operations about user")

与Controller注解并列使用。 属性配置：

在SpringMvc中的配置如下：

@Controller
@RequestMapping(value = "/api/pet", produces = {APPLICATION_JSON_VALUE, APPLICATION_XML_VALUE})
@Api(value = "/pet", description = "Operations about pets")
public class PetController {
    
}

定义后swagger效果图： 

ApiOperation每一个url资源的定义

使用方式：

@ApiOperation(
          value = "Find purchase order by ID",
          notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
          response = Order,
          tags = {"Pet Store"})

与Controller中的方法并列使用。

属性配置：

在SpringMvc中的配置如下：

@RequestMapping(value = "/order/{orderId}", method = GET)
  @ApiOperation(
      value = "Find purchase order by ID",
      notes = "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions",
      response = Order.class,
      tags = { "Pet Store" })
   public ResponseEntity<Order> getOrderById(@PathVariable("orderId") String orderId)
      throws NotFoundException {
    Order order = storeData.get(Long.valueOf(orderId));
    if (null != order) {
      return ok(order);
    } else {
      throw new NotFoundException(404, "Order not found");
    }
  }

swagger效果图： 

ApiParam请求属性

使用方式：

public ResponseEntity<User> createUser(@RequestBody @ApiParam(value = "Created user object", required = true)  User user)

与Controller中的方法并列使用。

属性配置：

在SpringMvc中的配置如下：

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

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("");
  }

效果图展示： 

ApiResponses相应集配置

使用方式：

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

与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("");
  }

ResponseHeader相应配置

使用方式：

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

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

在SpringMvc中的配置如下：

@ApiModel(description = "群组")

ApiModel相应配置

使用方式：

属性配置：

在SpringMvc中的配置如下：

@ApiModel(description = "群组")
public class UamGroup {}

ApiModelProperty相应配置

使用方式：

@ApiModelProperty(required = true, value = "群组的Id")

属性配置：

在SpringMvc中的配置如下：

@ApiModelProperty(required = true, value = "群组的Id")
    private String groupId;

转自：https://my.oschina.net/zzuqiang/blog/793606