| access | 不过多描述 |
| allowMultiple | 默认为false |
| hidden | 隐藏该属性 |
| example | 举例子 |
实例:
public ResponseEntity getOrderById(
@ApiParam(value = “ID of pet that needs to be fetched”, allowableValues = “range[1,5]”, required = true)
@PathVariable(“orderId”) String orderId)
3、@ApiImplicitParams、@ApiImplicitParam
========================================================================================================
@ApiImplicitParams、@ApiImplicitParam也可以定义参数.
-
@ApiImplicitParams:用在请求的方法上,包含一组参数说明
-
@ApiImplicitParam:对单个参数的说明
主要属性:
| 属性 | 描述 |
| — | — |
| name | 参数名 |
| value | 参数的说明、描述 |
| required | 参数是否必须必填 |
| paramType | 参数放在哪个地方
query --> 请求参数的获取:@RequestParam
header --> 请求参数的获取:@RequestHeader
path(用于restful接口)–> 请求参数的获取:@PathVariable