SpringFox是一个用于集成Swagger和Spring框架的开源项目,它提供了自动生成API文档的功能。然而,SpringFox项目在2020年停止了更新,并且已被其继任者SpringDoc取代。因此,如果您使用的是旧版本的SpringFox,迁移到SpringDoc是一个明智的选择,以获得更好的支持和最新的功能。
移除SpringFox和Swagger 2的依赖项,并添加springdoc-openapi-starter-webmvc-ui依赖项代替。
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.1.0</version>
</dependency>
将Swagger 2的注解替换为Swagger 3的注解(已包含在springdoc-openapi-starter-webmvc-ui依赖中)。Swagger 3注解的包名是io.swagger.v3.oas.annotations。
- @Api → @Tag
- @ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
- @ApiImplicitParam → @Parameter
- @ApiImplicitParams → @Parameters
- @ApiModel → @Schema
- @ApiModelProp
版权声明:本文为qq_29901385原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。