如何为Swagger生成的客户端调用添加自定义请求头（复杂方案）

我有一个包含诸多业务方法的Web API，该API通过自定义中间件读取请求中的特定Header以校验API密钥，若无此密钥部分调用会被拦截，但接口方法本身并未要求传入该密钥。
我创建了第二个项目并导入了服务引用，现在需要调用这些接口方法，但生成的客户端方法不支持将密钥作为额外参数传入，因此需要通过其他方式在请求中添加该Header。现有代码如下：

HttpClient client = new();    
AccountsClient accounts = new("http://localhost:5401", client);
accounts.LoginAsync("Username", "Password").Wait();

注：该Web API不受我控制，无法进行修改。

解决方案 #

1. 给HttpClient添加全局默认请求头 #

这是最直接的方式，给你创建的HttpClient实例设置默认Header后，所有通过该客户端发起的请求都会自动带上API密钥：

HttpClient client = new();
// 替换为实际的Header键名和你的API密钥值
client.DefaultRequestHeaders.Add("X-API-Key", "your-api-key-value");

AccountsClient accounts = new("http://localhost:5401", client);
accounts.LoginAsync("Username", "Password").Wait();

适合所有请求都需要携带密钥的场景，一次设置全局生效。

2. 直接操作客户端关联的HttpClient #

如果生成的AccountsClient暴露了内部的HttpClient实例，也可以直接给它添加Header：

HttpClient client = new();
AccountsClient accounts = new("http://localhost:5401", client);

// 添加API密钥Header
accounts.HttpClient.DefaultRequestHeaders.Add("X-API-Key", "your-api-key-value");

accounts.LoginAsync("Username", "Password").Wait();

3. 使用自定义DelegatingHandler拦截请求（灵活场景） #

如果需要更灵活的控制——比如仅部分请求携带密钥、动态更新密钥等——可以自定义一个DelegatingHandler来统一处理请求头：

public class ApiKeyHandler : DelegatingHandler
{
    private readonly string _headerName;
    private readonly string _apiKey;

    public ApiKeyHandler(string headerName, string apiKey)
    {
        _headerName = headerName;
        _apiKey = apiKey;
    }

    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
    {
        // 给每个请求添加API密钥Header
        request.Headers.Add(_headerName, _apiKey);
        return await base.SendAsync(request, cancellationToken);
    }
}

然后用这个Handler创建HttpClient：

// 初始化自定义Handler，传入Header键名和密钥
var apiKeyHandler = new ApiKeyHandler("X-API-Key", "your-api-key-value");
var client = new HttpClient(apiKeyHandler);

AccountsClient accounts = new("http://localhost:5401", client);
accounts.LoginAsync("Username", "Password").Wait();

这种方式可以在Handler中扩展更多逻辑，比如密钥过期自动刷新、根据请求路径决定是否添加密钥等。

内容的提问来源于stack exchange，提问作者Wim ten Brink