refactor(SwaggerConfig.,java): 优化接口文档配置,全局 Authorization 请求头参数配置

This commit is contained in:
haoxr
2023-10-17 21:49:14 +08:00
parent 77960dcf81
commit b6ee9d913a

View File

@@ -1,25 +1,21 @@
package com.youlai.system.config; package com.youlai.system.config;
import io.swagger.v3.oas.models.*; import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info; import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License; import io.swagger.v3.oas.models.security.SecurityRequirement;
import io.swagger.v3.oas.models.security.SecurityScheme; import io.swagger.v3.oas.models.security.SecurityScheme;
import org.springdoc.core.customizers.OpenApiCustomizer; import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpHeaders;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
/** /**
* Swagger 配置 * Swagger 配置
* <p> * <p>
* Spring Doc FAQ: https://springdoc.org/#faq
* *
* @author haoxr * @author haoxr
* @see <a href="https://doc.xiaominfo.com/docs/quick-start">knife4j 快速开始</a>
* @since 2023/2/17 * @since 2023/2/17
*/ */
@Configuration @Configuration
@@ -29,36 +25,33 @@ public class SwaggerConfig {
* 接口信息 * 接口信息
*/ */
@Bean @Bean
public OpenAPI apiInfo() { public OpenAPI openApi() {
return new OpenAPI() return new OpenAPI()
.info(new Info()
.title("系统接口文档")
.version("2.4.0")
)
//全局安全校验项也可以在对应的controller上加注解SecurityRequirement
.components(new Components() .components(new Components()
.addSecuritySchemes("Authorization", .addSecuritySchemes(HttpHeaders.AUTHORIZATION,
new SecurityScheme().type(SecurityScheme.Type.HTTP) new SecurityScheme()
.scheme("bearer").bearerFormat("JWT") .name(HttpHeaders.AUTHORIZATION)
.type(SecurityScheme.Type.APIKEY)
.in(SecurityScheme.In.HEADER)
.scheme("Bearer")
.bearerFormat("JWT")
) )
) )
.info(new Info() .addSecurityItem(new SecurityRequirement().addList(HttpHeaders.AUTHORIZATION)) ;
.title("youlai-boot 接口文档")
.version("2.0.0")
.description("接口文档")
.license(new License().name("Apache 2.0")
.url("https://www.youlai.tech"))
);
} }
/**
* 系统接口分组
*/
@Bean @Bean
public GroupedOpenApi systemApi() { public GlobalOpenApiCustomizer globalOpenApiCustomizer() {
String[] paths = {"/**"}; return openApi -> openApi.getPaths().values()
String[] packagesToScan = {"com.youlai.system.controller"}; .stream()
return GroupedOpenApi.builder() .flatMap(pathItem -> pathItem.readOperations().stream())
.group("系统接口") .forEach(operation -> operation.security(openApi.getSecurity()));
.packagesToScan(packagesToScan)
.pathsToMatch(paths)
.build();
} }
} }