spring-boot - 如何添加“授权：承载" 在使用 Springdoc Open API 3 Spec 的 OAuth2 隐式流的标头中

Question

我正在从 Springfox 迁移到 Springdoc Open Api 3，并且正在尝试实现身份验证流程：

目前，我已经实现了一个隐式的身份验证流程。如下所示：

        @Bean
        public OpenAPI customOpenAPI()
        {
            String authorizeUrl = <authorize-url>;
    
            OAuthFlow oAuthFlow = new OAuthFlow();
            oAuthFlow.authorizationUrl(authorizeUrl);
            
            return new OpenAPI()
                .components(new Components()
                        .addSecuritySchemes("OAuth", new SecurityScheme()
                                .type(Type.OAUTH2)
                                .scheme("bearer")
                                .in(In.HEADER)
                                .bearerFormat("jwt")
                                .flows(new OAuthFlows().implicit(oAuthFlow))
                                )
                        );
            
        }

现在，问题是，我正确地被重定向到 Keycloak 服务器并且身份验证按预期工作，但是当我尝试从 Swagger UI 执行请求时，请求Authorization:Bearer <token>中丢失了。

我尝试了多种解决方案，例如在端点上添加安全方案要求，但它不起作用。我错过了什么吗？还是我的实施流程有误？我在发送到后端的每个请求中都需要 Bearer 令牌。

标签： spring-bootoauth-2.0swaggeropenapispringdoc

Answer 1

因此，在尝试了几乎所有内容之后，以下解决方案对我有用：

return new OpenAPI()
    .components(new Components()
        .addSecuritySchemes("OAuth", new SecurityScheme()
            .type(Type.OAUTH2)
            .scheme("bearer")
            .bearerFormat("jwt")
            .in(In.HEADER)
            .name("Authorization")
            .flows(new OAuthFlows().implicit(oAuthFlow))))
            .addSecurityItem(new SecurityRequirement().addList("OAuth"));

所以，我做的大部分配置都是正确的，但必须添加SecurityRequirement哪些要求所有 API 在标头中都有授权令牌。