java - 在springdoc-openapi-ui中为基本身份验证启用授权按钮

Question

如何为基本身份验证启用springdoc-openapi-ui(OpenAPI 3.0 /swagger-ui.html)中的“授权”按钮。

必须在Spring @Controller和@Configuration类中添加哪些注释？

Answer 1

使用@io.swagger.v3.oas.annotations.security.SecurityScheme bean中的注释@Configuration为OpenAPI 3.0定义全局安全性方案:

@Configuration
@OpenAPIDefinition(info = @Info(title = "My API", version = "v1"))
@SecurityScheme(
    name = "basicAuth",
    type = SecuritySchemeType.HTTP,
    scheme = "basic"
)
public class OpenApi30Config {

}

使用引用已定义的安全方案的 @RestController注释每个需要基本身份验证的 @io.swagger.v3.oas.annotations.Operation方法:

@Operation(summary = "My endpoint", security = @SecurityRequirement(name = "basicAuth"))