Swashbuckle.AspNetCore中API Key安全方案的正确配置方法

在使用Swashbuckle.AspNetCore为ASP.NET Core API生成Swagger文档时，配置API Key安全方案是一个常见需求。本文将详细介绍如何正确配置API Key安全方案，特别是当API Key需要放在请求头中的情况。

问题背景

许多开发者在使用Swashbuckle.AspNetCore 6.6.2版本时，会遇到一个典型问题：虽然按照文档配置了API Key安全方案，Swagger UI也显示了授权按钮，但实际发送请求时却没有包含配置的API Key头信息。

正确配置方法

要完整实现API Key安全方案，需要两个步骤的配置：

1. 定义安全方案：使用AddSecurityDefinition方法定义API Key方案
2. 应用安全要求：使用AddSecurityRequirement方法指定哪些端点需要该安全方案

完整配置示例

builder.Services.AddSwaggerGen(o =>
{
    // 第一步：定义安全方案
    o.AddSecurityDefinition(
        "ApiKey", 
        new OpenApiSecurityScheme { 
            Description = "ApiKey必须出现在请求头中", 
            Type = SecuritySchemeType.ApiKey, 
            Name = "X-API-KEY", 
            In = ParameterLocation.Header 
        }
    );
    
    // 第二步：应用安全要求
    o.AddSecurityRequirement(
        new OpenApiSecurityRequirement
        {
            {
                new OpenApiSecurityScheme
                {
                    Reference = new OpenApiReference
                    {
                        Type = ReferenceType.SecurityScheme,
                        Id = "ApiKey"
                    }
                },
                Array.Empty<string>()
            }
        }
    );
});

配置解析

1. 安全方案定义：

   • Type = SecuritySchemeType.ApiKey：指定这是一个API Key类型的安全方案
   • Name = "X-API-KEY"：指定API Key在请求头中的名称
   • In = ParameterLocation.Header：指定API Key位于请求头中

2. 安全要求应用：

   • 这部分配置告诉Swagger哪些端点需要API Key认证
   • Reference指向之前定义的安全方案
   • Array.Empty<string>()表示不需要特定的作用域

常见误区

许多开发者只完成了第一步（定义安全方案），而忽略了第二步（应用安全要求），这会导致Swagger UI显示授权按钮但实际不发送API Key的情况。

验证配置

配置完成后，可以通过以下步骤验证：

1. 运行应用并访问Swagger UI页面
2. 点击右上角的"Authorize"按钮
3. 输入API Key值并保存
4. 执行任意API端点
5. 检查请求头中是否包含X-API-KEY字段

进阶配置

如果需要更精细的控制，可以针对特定端点或控制器应用不同的安全要求：

// 全局安全要求
o.AddSecurityRequirement(/* 同上 */);

// 特定端点的安全要求可以通过OperationFilter实现
o.OperationFilter<ApiKeyOperationFilter>();

其中ApiKeyOperationFilter可以自定义哪些端点需要或不需要API Key认证。

总结

正确配置Swashbuckle.AspNetCore的API Key安全方案需要同时完成安全方案定义和安全要求应用两个步骤。理解这一机制可以帮助开发者避免常见的配置陷阱，确保API Key被正确发送到服务端。