具有多个 API 密钥的 Swagger

Question

我正在开发一个 API ASP.Net Core (net6.0)，其中通过请求在请求标头中传递密钥 (X-API-KEY) 和应用程序 id (X-APP-ID) 来实现身份验证。

https://swagger.io/docs/specification/authentication/api-keys/的“多个 API 密钥”部分对此进行了描述

我在 Program.cs 中配置此功能的代码可以在下面找到。

builder.Services.AddSwaggerGen(c =>
{    
    c.AddSecurityDefinition("apiKey", new OpenApiSecurityScheme()
    {
        Description = "API KEY",
        Name = "X-API-KEY",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey
    });

    c.AddSecurityDefinition("appId", new OpenApiSecurityScheme()
    {
        Description = "APP ID",
        Name = "X-APP-ID",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey
    });

    c.AddSecurityRequirement(new OpenApiSecurityRequirement()
    {
        {
            new OpenApiSecurityScheme
            {
                Reference = new OpenApiReference
                {
                    Type = ReferenceType.SecurityScheme,
                    Id = "apiKey"
                }                
            },
            Array.Empty<string>()
        },
        {
            new OpenApiSecurityScheme
            {
                Reference = new OpenApiReference
                {
                    Type = ReferenceType.SecurityScheme,
                    Id = "appId"
                }
            },
            Array.Empty<string>()
        }
    });
});

当前的配置结果如下，实际上可以工作，但是如果在一个部分中只有一个“授权”和“关闭”按钮以及两个文本框，那就更好了。

我希望我只是缺少配置方面的调整。非常感谢任何帮助。

Answer 1

您的配置是正确的。这就是 Swagger UI 目前呈现 API 密钥对的方式。这是现有的增强请求：
https ://github.com/swagger-api/swagger-ui/issues/3521