码迷,mamicode.com
首页 > Windows法式榜样 > 详细

swagger注释API详细解释

时间:2018-03-07 11:45:43      浏览:18267      评论:0      收藏:0      [点我收藏+]

标签:reference   path   ons   根本   状况   .class   param   options   except   

经常使用到的注解有:
  • Api
  • ApiModel
  • ApiModelProperty
  • ApiOperation
  • ApiParam
  • ApiResponse
  • ApiResponses
  • ResponseHeader
1. api标记

Api 用在类上,解释该类的感化。可以标记一个Controller类做为swagger 文档资本,应用方法:

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

与Controller注解并列应用。 属性设备:

属性称号备注
value url的途径值
tags 假设设置这个值、value的值会被覆盖
description 对api资本的描述
basePath 根本途径可以不设备
position 假设设备多个Api 想改变显示的次序地位
produces For example, "application/json, application/xml"
consumes For example, "application/json, application/xml"
protocols Possible values: http, https, ws, wss.
authorizations 高等特点认证时设备
hidden 设备为true 将在文档中隐蔽

在SpringMvc中的设备以下:

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

}
2. ApiOperation标记

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中的办法并列应用。
属性设备:

属性称号备注
value url的途径值
tags 假设设置这个值、value的值会被覆盖
description 对api资本的描述
basePath 根本途径可以不设备
position 假设设备多个Api 想改变显示的次序地位
produces For example, "application/json, application/xml"
consumes For example, "application/json, application/xml"
protocols Possible values: http, https, ws, wss.
authorizations 高等特点认证时设备
hidden 设备为true 将在文档中隐蔽
response 前往的对象
responseContainer 这些对象是有效的 "List", "Set" or "Map".,其他有效
httpMethod "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"
code http的状况码 默许 200
extensions 扩大属性

在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");
    }
  }
3. ApiParam标记

ApiParam请求属性,应用方法:

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

与Controller中的办法并列应用。

属性设备:

属性称号备注
name 属性称号
value 属性值
defaultValue 默许属性值
allowableValues 可以不设备
required 能否属性必填
access 不过量描述
allowMultiple 默许为false
hidden 隐蔽该属性
example 举例子

在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)
4. ApiResponse

ApiResponse:照应设备,应用方法:

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

与Controller中的办法并列应用。 属性设备:

属性称号备注
code http的状况码
message 描述
response 默许照应类 Void
reference 参考ApiOperation中设备
responseHeaders 参考 ResponseHeader 属性设备解释
responseContainer 参考ApiOperation中设备

在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("");
  }
5. ApiResponses

ApiResponses:照应集设备,应用方法:

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

与Controller中的办法并列应用。 属性设备:

属性称号备注
value 多个ApiResponse设备

在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中的办法并列应用。 属性设备:

属性称号备注
name 照应头称号
description 头描述
response 默许照应类 Void
responseContainer 参考ApiOperation中设备

在SpringMvc中的设备以下:

@ApiModel(description = "群组")
7. 其他
  • @ApiImplicitParams:用在办法上包含一组参数解释;
  • @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
    • paramType:参数放在哪个处所
    • name:参数代表的含义
    • value:参数称号
    • dataType: 参数类型,有String/int,无用
    • required : 能否须要
    • defaultValue:参数的默许值
  • @ApiResponses:用于表示一组照应;
  • @ApiResponse:用在@ApiResponses中,普通用于表达一个缺点的照应信息;
    • code: 照应码(int型),可自定义
    • message:状况码对应的照应信息
  • @ApiModel:描述一个Model的信息(这类普通用在post创建的时辰,应用@RequestBody如许的场景,请求参数没法应用@ApiImplicitParam注解停止描述的时辰;
  • @ApiModelProperty:描述一个model的属性。


作者:Xiangdong_She
链接:https://www.jianshu.com/p/12f4394462d5
來源:简书
著作权归作者一切。贸易转载请接洽作者取得授权,非贸易转载请注明出处。

swagger注释API详细解释

标签:reference   path   ons   根本   状况   .class   param   options   except   

原文地址:https://www.cnblogs.com/hyl8218/p/8520994.html

(2)
(3)
   
告发
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权一切 京ICP备13008772号-2
迷上了代码!