03.06 Swagger2添加Authorization請求頭

Swagger中添加Authorization請求頭需要配置securitySchemes和securityContexts。

<code>@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("demo")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.regex("/api/.*"))
                .build()
                # 增加Authorization請求頭
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
    }

    private List<apikey> securitySchemes() {
        List<apikey> apiKeys = new ArrayList<>();
        apiKeys.add(new ApiKey("Authorization", "Authorization", "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("Authorization", authorizationScopes));
        return securityReferences;
    }
}
/<securityreference>/<securityreference>/<securitycontext>/<securitycontext>/<apikey>/<apikey>/<code>

閱讀更多 Java實用技術 的文章

關鍵字: List return 請求