SpringBoot3 Swagger笔记整理

yicj2024-09-30 14:41

添加依赖

xml 复制代码

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

编写配置类

java 复制代码

@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("https://springdoc.org")))
              .addSecurityItem(buildSecurityRequirement())
              .components(new Components().securitySchemes(buildSecuritySchemes()))
              .externalDocs(new ExternalDocumentation()
                      .description("SpringShop Wiki Documentation")
                      .url("https://springshop.wiki.github.org/docs"));
   }

   private SecurityRequirement buildSecurityRequirement() {
      SecurityRequirement securityRequirement = new SecurityRequirement();
      securityRequirement.addList("token");
      securityRequirement.addList("basic");
      return securityRequirement;
   }

   private Map<String, SecurityScheme> buildSecuritySchemes() {
      Map<String, SecurityScheme> securitySchemes = new HashMap<>();
      // token
      SecurityScheme token = new SecurityScheme()
              .type(SecurityScheme.Type.APIKEY) // 类型
              .name("token") // 请求头的 name
              .in(SecurityScheme.In.HEADER);
      securitySchemes.put("token", token);
      // basic
      SecurityScheme basic = new SecurityScheme()
              .type(SecurityScheme.Type.APIKEY) // 类型
              .name("Authorization")
              .in(SecurityScheme.In.HEADER) ;
      securitySchemes.put("basic", basic);
      return securitySchemes;
   }
}

application.yml配置

yaml 复制代码

springdoc:
  api-docs:
    enabled: true
    path: /v3/api-docs
  swagger-ui:
    enabled: true
    path: /index.html
  packages-to-scan: com.yicj.study.springdoc.controller

启动项目，访问http://localhost:8081/swagger-ui/index.html，即可查看API文档