本文主要是介绍注解变化,从Swagger2迁移到Swagger3,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
将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 |
这篇关于注解变化,从Swagger2迁移到Swagger3的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!