Swagger常用注解,Java初级程序员应该掌握的知识

private List queryById( @ApiParam(name = “id”, value = “学生id”, required = true) @PathVariable(“id”) Long id) {@ApiImplicitParam(name=“age”,value=“年龄”,required=true,paramType=“form”,dataType=“Integer”)@ApiResponse(code = 400, message = “请求参数没填好”),
摘要由CSDN通过智能技术生成

| 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

  • 11
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值