采集详情

huliguo

5 天以前 b36ba9d3da79245376f5a8a1c31cddb1f9a6d1b5

 src/main/java/com/linghu/config/Swagger2Config.java

@@ -5,42 +5,65 @@
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
@Configuration
@EnableSwagger2  // 开启Swagger2
@EnableSwagger2
public class Swagger2Config {

    /**
     * 配置Swagger2核心对象Docket
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // 配置API文档基本信息
                .apiInfo(apiInfo())
                // 选择需要生成文档的接口
                .select()
                // 扫描指定包下的接口（替换为你的Controller包路径）
                .apis(RequestHandlerSelectors.basePackage("com.linghu.controller"))
                // 匹配所有路径
                .paths(PathSelectors.any())
                .build()
                // 重点修改：使用 securitySchemes + securityContext 替代全局参数
                .securitySchemes(Arrays.asList(apiKey()))  // 添加安全方案
                .securityContexts(Arrays.asList(securityContext())); // 应用安全上下文
    }

    // 1. 定义安全方案（在Swagger UI顶部添加Authorize按钮）
    private ApiKey apiKey() {
        return new ApiKey("BearerToken", "Authorization", "header");
    }

    // 2. 配置安全上下文（全局生效）
    private SecurityContext securityContext() {
        return SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.any()) // 对所有路径生效
                .build();
    }

    /**
     * 配置API文档基本信息（标题、描述、作者等）
     */
    // 3. 设置默认授权范围
    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Arrays.asList(new SecurityReference("BearerToken", authorizationScopes));
    }
//http://localhost:8080/swagger-ui.html
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("灵狐GEO系统 接口文档")  // 文档标题
                .description("使用 Swagger2 生成的API文档")  // 文档描述
                .version("1.0.0")  // 版本号

                .title("灵狐GEO系统 接口文档")
                .description("使用 Swagger2 生成的API文档")
                .version("1.0.0")
                .build();
    }
}