refactor(api-doc): 新增鉴权配置

continew-starter-api-doc/src/main/java/top/charles7c/continew/starter/apidoc/autoconfigure/SpringDocAutoConfiguration.java

@@ -16,15 +16,21 @@
 
 package top.charles7c.continew.starter.apidoc.autoconfigure;
 
+import cn.hutool.core.map.MapUtil;
+import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.info.Contact;
 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 jakarta.annotation.PostConstruct;
 import lombok.extern.slf4j.Slf4j;
+import org.springdoc.core.customizers.GlobalOpenApiCustomizer;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.PropertySource;
 import org.springframework.http.CacheControl;
@@ -34,6 +40,8 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 import top.charles7c.continew.starter.core.autoconfigure.project.ProjectProperties;
 import top.charles7c.continew.starter.core.handler.GeneralPropertySourceFactory;
 
+import java.util.List;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
 
@@ -47,6 +55,7 @@ import java.util.concurrent.TimeUnit;
 @EnableWebMvc
 @AutoConfiguration
 @ConditionalOnProperty(name = "springdoc.swagger-ui.enabled", havingValue = "true")
+@EnableConfigurationProperties(SpringDocExtensionProperties.class)
 @PropertySource(value = "classpath:default-api-doc.yml", factory = GeneralPropertySourceFactory.class)
 public class SpringDocAutoConfiguration implements WebMvcConfigurer {
 
@@ -63,23 +72,62 @@ public class SpringDocAutoConfiguration implements WebMvcConfigurer {
      */
     @Bean
     @ConditionalOnMissingBean
-    public OpenAPI openApi(ProjectProperties properties) {
+    public OpenAPI openApi(ProjectProperties projectProperties, SpringDocExtensionProperties properties) {
         Info info = new Info()
-                .title(String.format("%s %s", properties.getName(), "API 文档"))
+                .title(String.format("%s %s", projectProperties.getName(), "API 文档"))
-                .version(properties.getVersion())
+                .version(projectProperties.getVersion())
-                .description(properties.getDescription());
+                .description(projectProperties.getDescription());
-        ProjectProperties.Contact contact = properties.getContact();
+        ProjectProperties.Contact contact = projectProperties.getContact();
         if (null != contact) {
             info.contact(new Contact().name(contact.getName())
                     .email(contact.getEmail())
                     .url(contact.getUrl()));
         }
-        ProjectProperties.License license = properties.getLicense();
+        ProjectProperties.License license = projectProperties.getLicense();
         if (null != license) {
             info.license(new License().name(license.getName())
                     .url(license.getUrl()));
         }
-        return new OpenAPI().info(info);
+        OpenAPI openAPI = new OpenAPI();
+        openAPI.info(info);
+        Components components = properties.getComponents();
+        if (null != components) {
+            openAPI.components(components);
+            // 鉴权配置
+            Map<String, SecurityScheme> securitySchemeMap = components.getSecuritySchemes();
+            if (MapUtil.isNotEmpty(securitySchemeMap)) {
+                SecurityRequirement securityRequirement = new SecurityRequirement();
+                List<String> list = securitySchemeMap.values().stream().map(SecurityScheme::getName).toList();
+                list.forEach(securityRequirement::addList);
+                openAPI.addSecurityItem(securityRequirement);
+            }
+        }
+        return openAPI;
+    }
+
+    /**
+     * 全局自定义配置（全局添加鉴权参数）
+     */
+    @Bean
+    @ConditionalOnMissingBean
+    public GlobalOpenApiCustomizer globalOpenApiCustomizer(SpringDocExtensionProperties properties) {
+        return openApi -> {
+            if (null != openApi.getPaths()) {
+                openApi.getPaths().forEach((s, pathItem) -> {
+                    // 为所有接口添加鉴权
+                    Components components = properties.getComponents();
+                    if (null != components && MapUtil.isNotEmpty(components.getSecuritySchemes())) {
+                        Map<String, SecurityScheme> securitySchemeMap = components.getSecuritySchemes();
+                        pathItem.readOperations().forEach(operation -> {
+                            SecurityRequirement securityRequirement = new SecurityRequirement();
+                            List<String> list = securitySchemeMap.values().stream().map(SecurityScheme::getName).toList();
+                            list.forEach(securityRequirement::addList);
+                            operation.addSecurityItem(securityRequirement);
+                        });
+                    }
+                });
+            }
+        };
     }
 
     @PostConstruct

continew-starter-api-doc/src/main/java/top/charles7c/continew/starter/apidoc/autoconfigure/SpringDocExtensionProperties.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
+ * <p>
+ * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * http://www.gnu.org/licenses/lgpl.html
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package top.charles7c.continew.starter.apidoc.autoconfigure;
+
+import io.swagger.v3.oas.models.Components;
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.NestedConfigurationProperty;
+
+
+/**
+ * API 文档扩展配置属性
+ *
+ * @author Charles7c
+ * @since 1.0.1
+ */
+@Data
+@ConfigurationProperties(prefix = "springdoc")
+public class SpringDocExtensionProperties {
+
+    /**
+     * 组件配置（包括鉴权配置等）
+     */
+    @NestedConfigurationProperty
+    private Components components;
+}