在 springdoc-openapi-ui 中为承载令牌身份验证(JWT)启用授权按钮

Enable Authorize button in springdoc-openapi-ui for Bearer Token Authentication (JWT)(在 springdoc-openapi-ui 中为承载令牌身份验证(JWT)启用授权按钮)
本文介绍了在 springdoc-openapi-ui 中为承载令牌身份验证(JWT)启用授权按钮的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着跟版网的小编来一起学习吧!

问题描述

如何在

解决方案

使用注解 @io.swagger.v3.oas.annotations.security.SecurityScheme 为 OpenAPI 3.0 定义全局安全方案@Configuration 豆:

@Configuration@OpenAPIDefinition(info = @Info(title = "我的 API", version = "v1"))@安全方案(name = "bearerAuth",类型 = SecuritySchemeType.HTTP,BearerFormat = "JWT",方案=承载者")公共类 OpenApi30Config {}

使用引用定义的安全方案的 @io.swagger.v3.oas.annotations.Operation 注释每个需要承载令牌身份验证 (JWT) 的 @RestController 方法:p>

@Operation(summary = "我的端点", security = @SecurityRequirement(name = "bearerAuth"))

How to enable "Authorize" button in springdoc-openapi-ui (OpenAPI 3.0 /swagger-ui.html) for Bearer Token Authentication, for example JWT.

What annotations have to be added to Spring @Controller and @Configuration classes?

解决方案

Define a global security scheme for OpenAPI 3.0 using annotation @io.swagger.v3.oas.annotations.security.SecurityScheme in a @Configuration bean:

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

}

Annotate each @RestController method requiring Bearer Token Authentication (JWT) with @io.swagger.v3.oas.annotations.Operation referencing the defined security scheme:

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

这篇关于在 springdoc-openapi-ui 中为承载令牌身份验证(JWT)启用授权按钮的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持跟版网!

本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除!

相关文档推荐

Reliable implementation of PBKDF2-HMAC-SHA256 for JAVA(PBKDF2-HMAC-SHA256 for JAVA 的可靠实现)
Correct way to sign and verify signature using bouncycastle(使用 bouncycastle 签名和验证签名的正确方法)
Creating RSA Public Key From String(从字符串创建 RSA 公钥)
Why java.security.NoSuchProviderException No such provider: BC?(为什么 java.security.NoSuchProviderException 没有这样的提供者:BC?)
Generating X509 Certificate using Bouncy Castle Java(使用 Bouncy Castle Java 生成 X509 证书)
How can I get a PublicKey object from EC public key bytes?(如何从 EC 公钥字节中获取 PublicKey 对象?)