在springdoc-openapi-ui中启用基本鉴权的授权按钮

Question

如何在springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html)中启用基本鉴权的授权按钮。

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

​

​

​

​

Answer 1

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

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

}

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

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