升级到springdoc的Swagger3

最新推荐文章于 2025-03-01 00:19:35 发布

流水随清风

最新推荐文章于 2025-03-01 00:19:35 发布

阅读量467

点赞数 4

文章标签： java

本文链接：https://blog.youkuaiyun.com/qq_31183727/article/details/137460736

版权

本文介绍了如何在SpringBoot3.0应用中从Swagger2迁移到Swagger3，包括依赖更新、注解变化以及创建配置类以设置API文档。详细列出了不同注解的迁移路径和示例代码。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

jdk 17、springboot3

依赖配置：就此一个依赖即可

   <dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.5.0</version>
   </dependency>

Swagger2->Swagger3注解

@Api → @Tag
@ApiIgnore → @Parameter(hidden = true) or @Operation(hidden = true) or @Hidden
@ApiImplicitParam → @Parameter
@ApiImplicitParams → @Parameters
@ApiModel → @Schema
@ApiModelProperty(hidden = true) → @Schema(accessMode = READ_ONLY)
@ApiModelProperty → @Schema
@ApiOperation(value = "foo", notes = "bar") → @Operation(summary = "foo", description = "bar")
@ApiParam → @Parameter
@ApiResponse(code = 404, message = "foo") → @ApiResponse(responseCode = "404", description = "foo")

添加Swagger配置类


import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SwaggerConfig {

  @Bean
  public OpenAPI springShopOpenAPI() {
      return new OpenAPI()
              .info(new Info().title("SpringShop API")
              .description("Spring shop sample application")
              .version("v0.0.1")
              .license(new License().name("Apache 2.0").url("http://springdoc.org")))
              .externalDocs(new ExternalDocumentation()
              .description("SpringShop Wiki Documentation")
              .url("https://springshop.wiki.github.org/docs"));
  }



}