SwaggerUI 不使用 Swashbuckle (5.x) 将 ApiKey 添加到 Header

Question

我正在使用 Swashbuckle.AspNetCore 5.0.0 为我的 .Net Core WebApi 项目生成 Swagger 文档，并且在大多数情况下，一切正常。

我已经使用 ApiKey 设置了一些简单的身份验证，效果很好。

我现在遇到的问题是让 Swagger 在我的请求标头中添加一个 ApiKey。我按照这些不同帖子中提到的添加 ApiKey 安全定义/要求的说明进行操作：

API key in header with swashbuckle

Empty authorization header on requests for Swashbuckle.AspNetCore

How to force Swagger/Swashbuckle to append an API key?

但是，ApiKey 值从未添加到 Header。

这就是我的创业公司：

c.AddSecurityDefinition("ApiKey",
    new OpenApiSecurityScheme
    {
         Description = "ApiKey must appear in header",
         Type = SecuritySchemeType.ApiKey,
         Name = Constants.ApiKeyHeaderName,
         In = ParameterLocation.Header
     });

和

c.AddSecurityRequirement(new OpenApiSecurityRequirement
{
   { 
       new OpenApiSecurityScheme 
       {
            Name = Constants.ApiKeyHeaderName, 
            Type = SecuritySchemeType.ApiKey, 
            In = ParameterLocation.Header
       },
       new List<string>()}
    });

Answer 1

我一直在努力解决这个问题，但发现除了添加适当的参考之外，您还必须在定义中指定方案，这是对我正确工作的代码：

c.AddSecurityDefinition("ApiKey", new OpenApiSecurityScheme()
{
    Name = "x-api-key",
    In = ParameterLocation.Header,
    Type = SecuritySchemeType.ApiKey,
    Description = "Authorization by x-api-key inside request's header",
    Scheme = "ApiKeyScheme"
});

var key = new OpenApiSecurityScheme()
{
    Reference = new OpenApiReference
    {
        Type = ReferenceType.SecurityScheme,
        Id = "ApiKey"
    },
    In = ParameterLocation.Header
};
var requirement = new OpenApiSecurityRequirement
{
   { key, new List<string>() }
};
c.AddSecurityRequirement(requirement);

Answer 2

好的，我终于能够让它工作了。我需要将 OpenApiReference 的实例添加到提供给 c.AddSecurityRequirement() 的 OpenApiSecurityScheme 对象

Reference = new OpenApiReference { Type = ReferenceType.SecurityScheme, Id = "ApiKeyAuth" }

我不得不说这方面的文档有点混乱。可能不是很小的一部分，因为互联网上发布的任何内容都永远存在，而且由于框架的变化，我在整个事情上发现的很多帖子不再适用:)

现在我只需要弄清楚如何将另一个标头值与 api-key 一起发送，我将完成这部分

Answer 3

重要提示是AddSecurityDefinition 中的name 必须与OpenApiReference 中的Id 相同。 name 可以是每个字符串。