pom.xml添加依赖项
org.springdoc
springdoc-openapi-spring-boot-2-webmvc
3.1.5
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端口方法 |
参考文档:https://stackoverflow.com/questions/59291371/migrating-from-springfox-swagger-2-to-springdoc-open-api
https://springdoc.org/#migrating-from-springfox