NSwag项目中如何获取HTTP响应头信息

在开发基于NSwag的API客户端时，我们经常需要处理HTTP响应头信息。本文将详细介绍如何在NSwag生成的C#客户端中正确获取响应头信息，特别是当API返回二进制数据流时的情况。

响应头在API定义中的重要性

现代Web API设计中，响应头经常承载重要的元数据信息。例如：

• 认证令牌
• 分页信息
• 速率限制状态
• 缓存控制指令
• 自定义业务标识

这些信息通常需要客户端能够方便地获取和处理。

NSwag中的FileResponse类

NSwag为处理二进制响应数据提供了专门的FileResponse类。这个类不仅包含响应数据流，还封装了完整的HTTP响应信息：

public partial class FileResponse : System.IDisposable
{
    public int StatusCode { get; private set; }
    public IReadOnlyDictionary<string, IEnumerable<string>> Headers { get; private set; }
    public System.IO.Stream Stream { get; private set; }
    // 其他成员...
}

关键属性说明：

• StatusCode: HTTP状态码
• Headers: 所有响应头的字典集合
• Stream: 响应体数据流

实际应用示例

假设我们有一个返回文件下载的API，并在响应头中包含自定义令牌：

1. API定义示例:

.WithOpenApi(openApi =>
{
    openApi.Responses.Add(
        StatusCodes.Status200OK.ToString(),
        new OpenApiResponse
        {
            Content = { /* 二进制响应定义 */ },
            Headers =
            {
                ["X-MY-TOKEN"] = new OpenApiHeader
                {
                    Description = "业务令牌",
                    Required = true,
                    Schema = new OpenApiSchema { Type = "string" }
                }
            }
        });
});

2. 客户端使用:

var response = await apiClient.DownloadFileAsync();
if (response.Headers.TryGetValue("X-MY-TOKEN", out var tokenValues))
{
    var token = tokenValues.FirstOrDefault();
    // 使用token进行后续处理
}

最佳实践建议

1. 头信息命名规范：使用标准化的头信息名称，如"X-"前缀表示自定义头
2. 错误处理：始终检查头信息是否存在，避免空引用异常
3. 资源释放：使用完FileResponse后调用Dispose()释放资源
4. 多值头处理：某些头可能有多个值，使用IEnumerable<string>处理

常见问题排查

如果无法获取预期的头信息，请检查：

1. API是否确实发送了该头信息
2. 头信息名称是否大小写敏感
3. 中间件是否修改或删除了头信息
4. CORS配置是否允许暴露该头信息

通过正确使用NSwag生成的FileResponse类，开发者可以方便地获取和处理HTTP响应中的各种头信息，实现更丰富的客户端逻辑。