注解@Api,@ApiOperation,@ApiParam说明

swagger的一些注释:

spring相关注解—@RequestParam和@ApiParam
https://blog.csdn.net/weixin_38345306/article/details/117082734

1.@API
是用在类上,表明是swagger资源,
拥有两个属性:value、tags

注:生成的api文档会根据tags分类,即这个controller中的所有接口生成的接口文档都会在tags这个list下;tags如果有多个值,会生成多个list,每个list都显示所有接口
在这里插入图片描述value的作用类似tags,但不能有多个值

2.@ApiOperation
是用在方法上,表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组

3.@ApiParam
是用在方法或参数上字段说明;表示对参数的添加元数据(说明或是否必填等)
name 参数名
value参数说明
required 是否必填

参考:https://blog.csdn.net/kang9399052316/article/details/105765068
@ApiModel:用对象来接收参数
@ApiProperty:用对象接收参数时,描述对象的一个字段
@ApiResponse:HTTP响应其中1个描述
@ApiResponses:HTTP响应整体描述
@ApiIgnore:使用该注解忽略这个API
@ApiError :发生错误返回的信息
@ApiImplicitParam:一个请求参数
@ApiImplicitParams:多个请求参数

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值