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

最新推荐文章于 2025-09-29 10:45:41 发布

原创

最新推荐文章于 2025-09-29 10:45:41 发布 · 2.7k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#java

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

swagger2注解

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