Spring OpenApi 3-如何设置clientId和clientSecret，以便在Swigger ui授权页面上自动显示？

Question

在我的Spring Boot应用程序上，我试图用OpenApi 3替换Swagger 2。在SwaggerConfiguration类的当前实现中，

@Configuration
@EnableSwagger2
public class SwaggerConfig {
...
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build()
            .securitySchemes(Collections.singletonList(securityScheme()))
            .host(host)
            .securityContexts(Collections.singletonList(securityContext()));
}

@Bean
public SecurityConfiguration security() {
    return SecurityConfigurationBuilder.builder()
            .clientId(swaggerCredentialsProvider.getClientId())
            .clientSecret(swaggerCredentialsProvider.getClientSecret())
            .scopeSeparator(" ")
            .useBasicAuthenticationWithAccessCodeGrant(true)
            .build();
}

private SecurityScheme securityScheme() {
    GrantType grantType = new AuthorizationCodeGrantBuilder()
            .tokenEndpoint(new TokenEndpoint(tokenEndpoint, "code"))
            .tokenRequestEndpoint(new TokenRequestEndpoint(tokenRequestEndpoint,
                    swaggerCredentialsProvider.getClientId(),
                    swaggerCredentialsProvider.getClientSecret()))
            .build();

    return new OAuthBuilder().name("spring_oauth")
            .grantTypes(Collections.singletonList(grantType))
            .scopes(Arrays.asList(scopes())).build();
}
...
}

在这个示例代码中，我给出了clientId和clientSecret，它将自动显示在swagger ui授权页面上：

在我的OpenApi配置的新实现中

@Bean
public OpenAPI customOpenAPI() {
    OAuthFlow oAuthFlow = new OAuthFlow()
            .tokenUrl(tokenEndpoint)
            .authorizationUrl(tokenRequestEndpoint)
            .scopes(new Scopes().addString(scope, ""));
    return new OpenAPI()
            .components(new Components()
                    .addSecuritySchemes("security_auth", new SecurityScheme()
                            .flows(new OAuthFlows().authorizationCode(oAuthFlow))
                            .type(SecurityScheme.Type.OAUTH2).scheme("oauth2")))
            .info(new Info()
                    .title(appName)
                    .version(appVersion)
                    .description(appDescription));
}

我没有找到设置这些信息的方法。我试图在application.property文件中设置springdoc.swagger-ui.oauth.clientid，但是clientId没有显示。

如何使用OpenApi 3设置clientId和clientSecret，以便在授权页面上自动显示？

Answer 1

您可以通过应用程序属性设置客户端id和客户端机密。我想你可能把客户id和客户机密的路径弄错了。属性是“客户端id”和“客户端机密”，而不是“clientId”和“clientSecret”

springdoc:
  swagger-ui:
    oauth:
      client-id: your-client-id-value
      client-secret: your-client-secret-value