Swagger3-带有自定义标头名称身份验证

 

一、集成swagger3方式

Java21 + SpringBoot3整合springdoc-openapi，自动生成在线接口文档，支持SpringSecurity和JWT认证方式_springdoc-openapi-starter-webflux-ui-CSDN博客

二、自定义标头名称

使用持有者身份验证，但需要在Authorize以外的标头中发送令牌。

根据RFC 7235和IANA HTTP Authentication Scheme Registry的定义，type: http用于HTTP身份验证。根据定义，HTTP身份验证使用Authorization报头。

要使用自定义header名称，需要将其定义为API key (type: apiKey)：

components:
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: X-Samanage-Authorization
      in: header

请注意，由于它是非标准的持有者方案，客户端将需要手动将“持有者”前缀添加到令牌值。例如，当您在Swagger UI中单击“授权”时，您需要输入“不记名令牌”，而不仅仅是“令牌”。