初始化
parent
d3b4c1e23c
commit
d47401d431
|
@ -1,11 +1,16 @@
|
||||||
package com.muyu.common.api.doc.config;
|
package com.muyu.common.api.doc.config;
|
||||||
|
|
||||||
|
import io.swagger.v3.oas.models.Components;
|
||||||
import io.swagger.v3.oas.models.ExternalDocumentation;
|
import io.swagger.v3.oas.models.ExternalDocumentation;
|
||||||
import io.swagger.v3.oas.models.OpenAPI;
|
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.security.SecurityRequirement;
|
||||||
|
import io.swagger.v3.oas.models.security.SecurityScheme;
|
||||||
|
import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
|
||||||
import org.springframework.beans.factory.annotation.Value;
|
import org.springframework.beans.factory.annotation.Value;
|
||||||
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;
|
||||||
|
|
||||||
@Configuration
|
@Configuration
|
||||||
public class SpringDocConfig {
|
public class SpringDocConfig {
|
||||||
|
@ -13,12 +18,13 @@ public class SpringDocConfig {
|
||||||
@Value("${spring.application.name}")
|
@Value("${spring.application.name}")
|
||||||
private String applicationName;
|
private String applicationName;
|
||||||
|
|
||||||
private Info info(){
|
private Info info() {
|
||||||
return new Info()
|
return new Info()
|
||||||
.title(String.format("%S-微服务接口文档", applicationName))
|
.title(String.format("%S-微服务接口文档", applicationName))
|
||||||
.description("微服务接口文档,根据此接口文档可以进行前后端功能对接/联调")
|
.description("微服务接口文档,根据此接口文档可以进行前后端功能对接/联调")
|
||||||
.version("v1.0.0");
|
.version("v1.0.0");
|
||||||
}
|
}
|
||||||
|
|
||||||
private ExternalDocumentation externalDocumentation() {
|
private ExternalDocumentation externalDocumentation() {
|
||||||
return new ExternalDocumentation()
|
return new ExternalDocumentation()
|
||||||
.description("服务总站")
|
.description("服务总站")
|
||||||
|
@ -29,6 +35,37 @@ public class SpringDocConfig {
|
||||||
public OpenAPI springShopOpenAPI() {
|
public OpenAPI springShopOpenAPI() {
|
||||||
return new OpenAPI()
|
return new OpenAPI()
|
||||||
.info(info())
|
.info(info())
|
||||||
.externalDocs(externalDocumentation());
|
.externalDocs(externalDocumentation())
|
||||||
|
// 配置全局鉴权参数-Authorize
|
||||||
|
.components(new Components()
|
||||||
|
.addSecuritySchemes(HttpHeaders.AUTHORIZATION,
|
||||||
|
new SecurityScheme()
|
||||||
|
.name(HttpHeaders.AUTHORIZATION)
|
||||||
|
.type(SecurityScheme.Type.APIKEY)
|
||||||
|
.in(SecurityScheme.In.HEADER)
|
||||||
|
.scheme("Bearer")
|
||||||
|
.bearerFormat("JWT")
|
||||||
|
)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
public GlobalOpenApiCustomizer globalOpenApiCustomizer() {
|
||||||
|
return openApi -> {
|
||||||
|
// 全局添加鉴权参数
|
||||||
|
if (openApi.getPaths() != null) {
|
||||||
|
openApi.getPaths().forEach((s, pathItem) -> {
|
||||||
|
// 登录接口/验证码不需要添加鉴权参数
|
||||||
|
if (s.equals("/login") || s.equals("/code")|| s.equals("/refresh")) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// 接口添加鉴权参数
|
||||||
|
pathItem.readOperations()
|
||||||
|
.forEach(operation ->
|
||||||
|
operation.addSecurityItem(new SecurityRequirement().addList(HttpHeaders.AUTHORIZATION))
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue