swagger2与swagger3的注解对应表
2021-12-13 本文已影响0人
fzhyzamt
pom.xml添加依赖项
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.6.0</version>
</dependency>
swagger3的包路径为io.swagger.v3.oas.annotations。
| swagger2 | swagger3 | 注解位置 |
|---|---|---|
| @Api | @Tag | Controller类 |
| @ApiOperation(value = "foo", notes = "bar") | @Operation(summary = "foo", description = "bar") | api端口方法 |
| @ApiImplicitParams | @Parameters | api端口方法 |
| @ApiImplicitParam | @Parameter | api方法的参数 |
| @ApiParam | @Parameter | api方法的参数 |
| @ApiIgnore | @Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden | 各处皆可 |
| @ApiModel | @Schema | DTO类 |
| @ApiModelProperty | @Schema | DTO属性 |
| @ApiModelProperty(hidden = true) | @Schema(accessMode = READ_ONLY) | DTO属性 |
| @ApiResponse(code = 404, message = "foo") | @ApiResponse(responseCode = "404", description = "foo") | api端口方法 |
参考:
