解决Swagger添加全局header获取不到的问题

最新推荐文章于 2023-09-19 22:40:40 发布

原创最新推荐文章于 2023-09-19 22:40:40 发布 · 2.2k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #swagger2 #header #ApiKey

swagger 专栏收录该内容

5 篇文章

订阅专栏

升级Swagger从2.7.0到2.9.2后，发现无法通过request获取header。解决方法是在Docket配置中添加securityContexts，确保安全上下文设置正确，包括securitySchemes和securityContexts，从而使Swagger接口请求带上header。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

问题描述

操作步骤：

解决方案：

问题描述

原来使用swagger的版本是2.7.0的，使用request可以获取到header

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

swagger配置：

package com.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
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.List;
 

@Configuration
@EnableSwagger2
public class Swagger2 {
 
    @Bean
    public Docket createRestApi() {
 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.controller"))
                .paths(PathSelectors.any())
                .build()
                
                .securitySchemes(securitySchemes());
 
    }
    private List<ApiKey> securitySchemes() {
        List<ApiKey> apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey("accessToken", "accessToken", "header"));
        return apiKeys;
    }
 
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot APIs")
                .description("")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

后来项目升级，swagger升级成2.9.2

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

其他的配置没变，发现使用request获取不到header

操作步骤：

点击Authorize设置token

点击请求接口，发现请求完的curl路径里，就没带请求头header，怪不得后台获取不到

解决方案：

加上上下文securityContexts

package com.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.*;
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.List;
 

@Configuration
@EnableSwagger2
public class Swagger2 {
 
    @Bean
    public Docket createRestApi() {
 
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.tfjybj.training.provider.controller"))
                .paths(PathSelectors.any())
                .build()
                
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
 
    }
    private List<ApiKey> securitySchemes() {
        List<ApiKey> apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey("accessToken", "accessToken", "header"));
        return apiKeys;
    }
 
    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts = new ArrayList<>();
        securityContexts.add(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.regex("^(?!auth).*$")).build());
        return securityContexts;
    }
    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences = new ArrayList<>();
        securityReferences.add(new SecurityReference("accessToken", authorizationScopes));
        return securityReferences;
    }
 
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SpringBoot APIs")
                .description("")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}