SWAGGER注释@API详细说明

swagger注释@API详细说明

swagger是当前最好用的Restful API文档生成的开源项目,通过swagger-spring项目实现了springMVC框架的无缝集成功能,方便生成restful风格的接口文档,

同时,swagger-ui还可以测试spring restful风格的接口功能

1 @ApiModelProperty

//  我这个用在实体类的get()方法上了/**
     * 获取城市编号
     * @return 城市编号
     */
    @ApiModelProperty(value="城市编号",example="058",required=true)
    public String getCode() {        return code;
    }    /**
     * 设置城市编号
     * @param code  城市编号
     */
    public void setCode(String code) {        this.code = code;
    }    /**
     * 获取城市名称
     * @return 城市名称
     */
    @ApiModelProperty(value="城市名称",example="guangZhou",required=true)
    public String getName() {        return name;
    }

2 @api

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

3 @ApiOperation

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

4 @ApiParam标记

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

5 @ApiResponse

 @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 @ApiResponses

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

7 @ResponseHeader

@ApiModel(description = "群组")

8 其他

• @ApiImplicitParams：用在方法上包含一组参数说明；

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

• paramType：参数放在哪个地方

• name：参数代表的含义

• value：参数名称

• dataType： 参数类型，有String/int，无用

• required ： 是否必要

• defaultValue：参数的默认值

• @ApiResponses：用于表示一组响应；

• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息；

• code： 响应码(int型)，可自定义

• message：状态码对应的响应信息

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

• @ApiModelProperty：描述一个model的属性。