swagger添加全局token

swagger添加全局token

swagger 目前來說還是是一個很完善的接口文檔說明和測試接口的工具，但正常使用時，我們的接口需要登陸才能訪問的。

即登陸時，要傳一個登陸後的token才能訪問的。
那這個怎麼設置，纔可以讓所有接口都允許登陸後訪問呢。
解決辦法如下：

@Configuration
@EnableSwagger2
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        ParameterBuilder ticketPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<Parameter>();
        ticketPar.name("Authorization").description("token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        pars.add(ticketPar.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.****.cloud.wsdl.controller"))
                .paths(PathSelectors.any())
                .build()
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts())
//                .globalOperationParameters(pars)
                ;
    }

    private List<ApiKey> securitySchemes() {
        List<ApiKey> apiKeyList= new ArrayList();
        apiKeyList.add(new ApiKey("Authorization", "Authorization", "header"));
        return apiKeyList;
    }

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

    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("Authorization", authorizationScopes));
        return securityReferences;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("cloud-demo 業務相關APIs")
                .description("cloud-demo 業務相關APIs")
                .termsOfServiceUrl("http://apiDocs.cloud.com")
                .version("1.0")
                .build();
    }
}

關鍵是在securitySchemes()方法配置裏增加需要token的配置。
配置完成後，swagger-ui.html裏右上角會有一個Authorize的按鈕，錄入該token即能成功調用相關接口