yangpeng
/
cloud-common-api-doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix():增加鉴权

master
yangpeng 2024-08-09 10:54:44 +08:00
parent c70094ba72
commit ee7599cbad
13 changed files with 63 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.idea/.gitignore vendored
View File

@ -1,8 +0,0 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml

13
.idea/compiler.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="CompilerConfiguration">
<annotationProcessing>
<profile name="Maven default annotation processors profile" enabled="true">
<sourceOutputDir name="target/generated-sources/annotations" />
<sourceTestOutputDir name="target/generated-test-sources/test-annotations" />
<outputRelativeToContentRoot value="true" />
<module name="cloud-common-api-doc" />
</profile>
</annotationProcessing>
</component>
</project>

7
.idea/encodings.xml
View File

@ -1,7 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="Encoding">
<file url="file://$PROJECT_DIR$/src/main/java" charset="UTF-8" />
<file url="file://$PROJECT_DIR$/src/main/resources" charset="UTF-8" />
</component>
</project>

45
.idea/jarRepositories.xml
View File

@ -1,45 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="RemoteRepositoriesConfiguration">
<remote-repository>
<option name="id" value="central" />
<option name="name" value="Central Repository" />
<option name="url" value="http://101.132.33.172:8081/repository/maven-public/" />
</remote-repository>
<remote-repository>
<option name="id" value="public" />
<option name="name" value="aliyun nexus" />
<option name="url" value="http://116.62.214.137:8081/repository/maven-public/" />
</remote-repository>
<remote-repository>
<option name="id" value="public" />
<option name="name" value="aliyun nexus" />
<option name="url" value="https://maven.aliyun.com/repository/public" />
</remote-repository>
<remote-repository>
<option name="id" value="central" />
<option name="name" value="Central Repository" />
<option name="url" value="http://maven.aliyun.com/nexus/content/groups/public/" />
</remote-repository>
<remote-repository>
<option name="id" value="central" />
<option name="name" value="Maven Central repository" />
<option name="url" value="https://repo1.maven.org/maven2" />
</remote-repository>
<remote-repository>
<option name="id" value="jboss.community" />
<option name="name" value="JBoss Community repository" />
<option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
</remote-repository>
<remote-repository>
<option name="id" value="central" />
<option name="name" value="Central Repository" />
<option name="url" value="http://116.62.214.137:8081/repository/maven-public/" />
</remote-repository>
<remote-repository>
<option name="id" value="public" />
<option name="name" value="aliyun nexus" />
<option name="url" value="http://101.132.33.172:8081/repository/maven-public/" />
</remote-repository>
</component>
</project>

12
.idea/misc.xml
View File

@ -1,12 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="ExternalStorageConfigurationManager" enabled="true" />
<component name="MavenProjectsManager">
<option name="originalFiles">
<list>
<option value="$PROJECT_DIR$/pom.xml" />
</list>
</option>
</component>
<component name="ProjectRootManager" version="2" languageLevel="JDK_17" default="true" project-jdk-name="17" project-jdk-type="JavaSDK" />
</project>

6
.idea/vcs.xml
View File

@ -1,6 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="$PROJECT_DIR$" vcs="Git" />
</component>
</project>

64
src/main/java/com/muyu/common/api/doc/config/SpringDocConfig.java
View File

@ -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 {
@ -29,6 +34,63 @@ 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")
)
);
} }
// /**
// * 全局自定义扩展
// * <p>
// * 在OpenAPI规范中，Operation 是一个表示 API 端点（Endpoint）或操作的对象。
// * 每个路径（Path）对象可以包含一个或多个 Operation 对象，用于描述与该路径相关联的不同 HTTP 方法（例如 GET、POST、PUT 等）。
// */
// @Bean
// public GlobalOpenApiCustomizer globalOpenApiCustomizer() {
// return openApi -> {
// // 全局添加鉴权参数
// if (openApi.getPaths() != null) {
// openApi.getPaths().forEach((s, pathItem) -> {
// // 接口添加鉴权参数
// pathItem.readOperations()
// .forEach(operation ->
// operation.addSecurityItem(new SecurityRequirement().addList(HttpHeaders.AUTHORIZATION))
// );
// });
// }
// };
// }
@Bean
public GlobalOpenApiCustomizer globalOpenApiCustomizer() {
return openApi -> {
// 全局添加鉴权参数
if (openApi.getPaths() != null) {
openApi.getPaths().forEach((s, pathItem) -> {
// 登录接口/验证码不需要添加鉴权参数
if (s.equals("/login") || s.equals("/code") || s.equals("/register")) {
return;
}
// 接口添加鉴权参数
pathItem.readOperations()
.forEach(operation ->
operation.addSecurityItem(new SecurityRequirement().addList(HttpHeaders.AUTHORIZATION))
);
});
}
};
}
} }

1
target/classes/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
View File

@ -1 +0,0 @@
com.muyu.common.api.doc.config.SpringDocConfig

BIN
target/classes/com/muyu/common/api/doc/config/SpringDocConfig.class
View File

Binary file not shown.

BIN
target/cloud-common-api-doc-3.6.3.jar
View File

Binary file not shown.

5
target/maven-archiver/pom.properties
View File

@ -1,5 +0,0 @@
#Generated by Maven
#Wed Jul 31 11:57:33 CST 2024
groupId=com.muyu
artifactId=cloud-common-api-doc
version=3.6.3

1
target/maven-status/maven-compiler-plugin/compile/default-compile/createdFiles.lst
View File

@ -1 +0,0 @@
com\muyu\common\api\doc\config\SpringDocConfig.class

1
target/maven-status/maven-compiler-plugin/compile/default-compile/inputFiles.lst
View File

@ -1 +0,0 @@
C:\Users\杨旭飞\Desktop\ExpertHighnSix\disassemble\cloud-common-api-doc\src\main\java\com\muyu\common\api\doc\config\SpringDocConfig.java