swagger2到swagger3的变化

Java知识技术分享

已于 2024-07-30 09:46:16 修改

阅读量396

点赞数 14

分类专栏： java技术文章标签： java 前端服务器

于 2024-07-29 15:40:27 首次发布

本文链接：https://blog.csdn.net/qq_42547733/article/details/140772550

版权

java技术专栏收录该内容

28 篇文章 1 订阅

订阅专栏

swagger2到swagger3的变化规则：

用在controller上：@Api → @Tag(name = “薪酬雇员银行卡”)
用在方法上：@ApiOperation(value = “foo”, notes = “bar”) → @Operation(summary = “方法名”, description = “描述”)
用在实体类上：@ApiModel(“User请求参数”) → @Schema(description = “入参”)
用在字段属性上：@ApiModelProperty → @Schema(description = “主键ID”, requiredMode = Schema.RequiredMode.REQUIRED, example = “1”)
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
requiredMode：指定该属性的必需性，Schema.RequiredMode.REQUIRED 表示这个属性是必需
example：提供该属性的示例值，展示该属性的一个具体示例

参数：@ApiParam → @Parameter
响应：@ApiResponse(code = 404, message = “foo”) → @ApiResponse(responseCode = “404”, description = “foo”)
@ApiIgnore→@Parameter(hidden = true)或@Operation(hidden = true)或@Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters