如何在Swashbuckle中为Web API2配置多请求头API Key认证

我来帮你搞定这个双认证参数的配置问题！

你要实现同时要求X-API-KEY和X-APP-ID两个头部认证参数的需求，在Swashbuckle里完全可以做到，下面是具体的配置步骤和细节：

1. 配置Security Definitions #

在你的SwaggerConfig.cs文件中，找到GlobalConfiguration.Configuration.EnableSwagger的配置块，添加两个ApiKey类型的安全定义，分别对应你的两个认证参数：

GlobalConfiguration.Configuration.EnableSwagger(c =>
{
    // 保留你已有的其他配置（比如文档标题、版本等）

    // 配置第一个API Key认证项
    c.ApiKey("apiKey")
      .Description("请输入API Key，参数位于请求头，键名为X-API-KEY")
      .Name("X-API-KEY")
      .In("header");

    // 配置第二个App ID认证项
    c.ApiKey("appId")
      .Description("请输入App ID，参数位于请求头，键名为X-APP-ID")
      .Name("X-APP-ID")
      .In("header");

    // 全局启用这两个认证（如果所有接口都需要验证的话）
    c.Security("apiKey", new[] { "apiKey" });
    c.Security("appId", new[] { "appId" });

    // 要是只有部分接口需要双认证，就别用上面的全局配置，改用下面的接口特性标记
})
.EnableSwaggerUi(c =>
{
    // 让Swagger UI支持输入这两个头部参数
    c.EnableApiKeySupport("X-API-KEY", "header");
    c.EnableApiKeySupport("X-APP-ID", "header");
});

2. 生成的Swagger Security Definitions结构 #

配置完成后，生成的Swagger文档里的securityDefinitions就会和你期望的结构完全匹配：

securityDefinitions:
  apiKey:
    type: apiKey
    in: header
    name: X-API-KEY
  appId:
    type: apiKey
    in: header
    name: X-APP-ID

3. 局部接口的双认证配置 #

如果不是所有接口都需要这两个认证参数，就去掉全局的c.Security配置，转而在需要的Controller或Action上添加SwaggerOperation特性，指定需要的安全策略：

[SwaggerOperation(Security = new[] { 
    new Dictionary<string, IEnumerable<string>> { 
        { "apiKey", new string[] {} }, 
        { "appId", new string[] {} } 
    } 
})]
public IHttpActionResult GetUserInfo()
{
    // 你的接口逻辑代码
}

4. 额外注意点 #

• Swashbuckle只负责文档展示和测试时的参数传递，真正的认证逻辑（验证这两个参数的有效性）需要你在Web API后端自行实现。
• 在Swagger UI页面，你可以分别输入X-API-KEY和X-APP-ID的值，测试时系统会自动把这两个参数加入请求头中。

这样配置后，你就能在Swagger文档里看到两个认证参数，并且正常测试需要双认证的接口啦！

内容的提问来源于stack exchange，提问作者nmbrphi