注解变化，从Swagger2迁移到Swagger3

hbwhypw

已于 2024-04-18 23:18:01 修改

阅读量1.1k

点赞数 5

CC 4.0 BY-SA版权

文章标签： java Swagger Springdoc

于 2024-04-12 23:24:33 首次发布

本文链接：https://blog.youkuaiyun.com/hbwhypw/article/details/137698074

本文对比了Swagger2与Swagger3在API注解、Pojo层、接口层、参数处理等方面的差异，帮助开发者顺利迁移至Swagger3（Springdoc）。

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

将Swagger2(Springfox)的注解替换为Swagger3(Springdoc)的注解。

Swagger2的注解包在 io.swagger.annotations；

Swagger3的注解包在 io. swagger.v3.oas.annotations。

	使用位置	Swagger2注解	Swagger3注解
pojo层	类上的	@ApiModel	@Schema
	属性上	@ApiModelProperty	@Schema
	需隐藏的属性上	@ApiModelProperty(hidden = true)	@Schema(accessMode = READ_ONLY)
接口层	类上	@Api	@Tag
	方法上	@ApiOperation(value = "", notes = "")	@Operation(summary = "", description = "")
	方法的参数上	@ApiImplicitParam	@Parameter
	方法的参数上	@ApiImplicitParams	@Parameters
	方法的参数上	@ApiParam	@Parameter
	方法的返回值	@ApiResponse	@ApiResponse
特殊	类上方法上参数上	@ApiIgnore	@Parameter(hidden = true) @Operation(hidden = true) @Hidden