如何为安全api添加swagger open api 3.0配置

Question

我启用了Swagger open API 3.0，如下所示:

添加了以下依赖项

    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.5.2</version>
    </dependency>
    <dependency>
        <groupId>org.springdoc</groupId>
        <artifactId>springdoc-openapi-ui</artifactId>
        <version>1.5.2</version>
    </dependency>

之后添加了下面的bean进行定制。

@Bean
public OpenAPI customOpenAPI(@Value("${application-description}") String appDesciption,
        @Value("${application-version}") String appVersion) {
    return new OpenAPI().info(new Info().title("One Money Backend API").version(appVersion)
            .description(appDesciption).termsOfService("http://swagger.io/terms/")
            .license(new License().name("Apache 2.0").url("http://springdoc.org")));
}

一切正常。我可以访问swagger-用户界面和api文档。

但是我有几个使用keycloak OAuth 2.0保护的api。当我试图访问这些安全的api时，我收到了未经授权的错误（这是意料之中的）。我也想从swagger open api 3.0中测试安全的api。

有人能帮我在swagger open api 3.0中启用授权吗？以测试我从swagger获得的安全api。

Answer 1

您需要添加< code>SecurityScheme bean，如下所示。根据您的验证类型，您可以更改< code >方案

对于基本

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI().components(new Components()
    .addSecuritySchemes("basicScheme", new SecurityScheme()
    .type(SecurityScheme.Type.HTTP).scheme("basic")));
}

为了JWT

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI().components(new Components()
    .addSecuritySchemes("bearer-key", new SecurityScheme()
    .type(SecurityScheme.Type.HTTP).scheme("bearer").bearerFormat("JWT")));
}

更多详细信息可在此处找到