Swagger2 非全局、無需重複輸入的Head參數（Token）配置

 

優化方案如下：

1. 通過Swagger2的securitySchemes配置全局參數：如下列代碼所示，securitySchemes的ApiKey中增加一個名爲“Authorization”，type爲“header”的參數。

private List<ApiKey> securitySchemes() {
        return newArrayList(
                new ApiKey("Authorization", "Authorization", "header"));
 }

1. 在Swagger2的securityContexts中通過正則表達式，設置需要使用參數的接口（或者說，是去除掉不需要使用參數的接口），如下列代碼所示，通過PathSelectors.regex("^(?!auth).*$")，所有包含"auth"的接口不需要使用securitySchemes。即不需要使用上文中設置的名爲“Authorization”，type爲“header”的參數。

private List<SecurityContext> securityContexts() {
        return newArrayList(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build()
        );
    }

設置完成後進入SwaggerUI，右上角出現“Authorization”按鈕，點擊即可輸入我們配置的參數。
對於不需要輸入參數的接口（上文所述的包含auth的接口），在未輸入Authorization參數就可以訪問。
其他接口則將返回401錯誤。點擊右上角“Authorization”按鈕，輸入配置的參數後即可訪問。參數輸入後全局有效，無需每個接口單獨輸入。

 

image.png

 

至此，完成Swagger2 非全局、無需重複輸入的Head參數配置。
Swagger2的相關完整代碼如下（工程基於Springboot）：

@Configuration
@EnableSwagger2
public class Swagger {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2).
                useDefaultResponseMessages(false)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.regex("^(?!auth).*$"))
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
                ;
    }

    private List<ApiKey> securitySchemes() {
        return newArrayList(
                new ApiKey("Authorization", "Authorization", "header"));
    }

    private List<SecurityContext> securityContexts() {
        return newArrayList(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build()
        );
    }

    List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return newArrayList(
                new SecurityReference("Authorization", authorizationScopes));
    }
}