swagger3注解用法详解.使用文档

本文详细介绍了如何从Swagger2注解迁移到Swagger3注解,包括SpringfoxBootStarter的版本更新,以及主要的迁移规则和示例变化,如@Api→@Tag,@ApiModelProperty→@Schema等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

swagger2注解

@Api:修饰整个类,描述Controller的作用
@ApiOperation:描述一个类的一个方法,或者说一个接口
@ApiParam:单个参数描述
 
@ApiModel:用对象来接收参数
@ApiProperty:用对象接收参数时,描述对象的一个字段
 
 
其它若干
@ApiResponseHTTP响应其中1个描述
 
@ApiResponsesHTTP响应整体描述
 
@ApiClass
 
@ApiError
 
@ApiErrors
 
@ApiParamImplicit
 
@ApiParamsImplicit

用 swagger 3 注释替换 swagger 2 注释

(它已经包含在springdoc-openapi-ui依赖项中)。swagger 3
注释的包是io.swagger.v3.oas.annotations

依赖项:
swagger3只需要一个依赖即

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值