HttpClient 请求的自定义标头

Question

如何向HttpClient 请求添加自定义标头？我正在使用PostAsJsonAsync 方法发布 JSON。我需要添加的自定义标题是

"X-Version: 1"

这是我到目前为止所做的：

using (var client = new HttpClient()) {
    client.BaseAddress = new Uri("https://api.clickatell.com/");
    client.DefaultRequestHeaders.Accept.Clear();
    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "xxxxxxxxxxxxxxxxxxxx");
    client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
    var response = client.PostAsJsonAsync("rest/message", svm).Result;
}

Answer 1

我找到了问题的答案。

client.DefaultRequestHeaders.Add("X-Version","1");

这应该为您的请求添加一个自定义标头

Answer 2

这是基于 Anubis 的答案（这是一种更好的方法，因为它不会修改每个请求的标头），但它更等同于原始问题中的代码：

using Newtonsoft.Json;
...

var client = new HttpClient();
var httpRequestMessage = new HttpRequestMessage
    {
        Method = HttpMethod.Post,
        RequestUri = new Uri("https://api.clickatell.com/rest/message"),
        Headers = { 
            { HttpRequestHeader.Authorization.ToString(), "Bearer xxxxxxxxxxxxxxxxxxx" },
            { HttpRequestHeader.Accept.ToString(), "application/json" },
            { "X-Version", "1" }
        },
        Content = new StringContent(JsonConvert.SerializeObject(svm))
    };

var response = client.SendAsync(httpRequestMessage).Result;

Answer 3

var request = new HttpRequestMessage {
    RequestUri = new Uri("[your request url string]"),
    Method = HttpMethod.Post,
    Headers = {
        { "X-Version", "1" } // HERE IS HOW TO ADD HEADERS,
        { HttpRequestHeader.Authorization.ToString(), "[your authorization token]" },
        { HttpRequestHeader.ContentType.ToString(), "multipart/mixed" },//use this content type if you want to send more than one content type
    },
    Content = new MultipartContent { // Just example of request sending multipart request
        new ObjectContent<[YOUR JSON OBJECT TYPE]>(
            new [YOUR JSON OBJECT TYPE INSTANCE](...){...}, 
            new JsonMediaTypeFormatter(), 
            "application/json"), // this will add 'Content-Type' header for the first part of request
        new ByteArrayContent([BINARY DATA]) {
            Headers = { // this will add headers for the second part of request
                { "Content-Type", "application/Executable" },
                { "Content-Disposition", "form-data; filename=\"test.pdf\"" },
            },
        },
    },
};

Answer 4

HttpRequestMessage 类中有一个 Headers 属性。您可以在那里添加自定义标头，这些标头将随每个 HTTP 请求一起发送。另一方面，HttpClient 类中的 DefaultRequestHeaders 设置使用该客户端对象发送的每个请求的标头，因此名称为 Default 请求标头。

希望这能让事情更清楚，至少对于将来看到这个答案的人来说。

Answer 5

我在 HttpClient 标头中添加了 x-api-version，如下所示：

var client = new HttpClient(httpClientHandler)
{
    BaseAddress = new Uri(callingUrl)
};
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Add("x-api-version", v2);

Answer 6

以防万一有人想知道如何调用 httpClient.GetStreamAsync() ，它没有使用 HttpRequestMessage 提供自定义标头的重载，您可以使用@Anubis 给出的上述代码并调用

await response.Content.ReadAsStreamAsync()

如果您要返回带有 Range Header 作为 FileStreamResult 的 blob url，则特别有用

Answer 7

我的两分钱。我同意heug。公认的答案令人费解。让我们退后一步。

默认标头适用于特定 HttpClient 发出的所有请求。因此，您将为共享标头使用默认标头。

_client.DefaultRequestHeaders.UserAgent.ParseAdd(_options.UserAgent);          

但是，我们有时需要特定于某个请求的标头。因此，我们会在方法中使用类似这样的东西：

public static async Task<HttpResponseMessage> GetWithHeadersAsync(this 
    HttpClient httpClient, string requestUri, Dictionary<string, string> headers)
    {
        using (var request = new HttpRequestMessage(HttpMethod.Get, requestUri))
        {
            foreach(var header in headers)
            {
                request.Headers.Add(header.Key, header.Value);
            }

            return await httpClient.SendAsync(request);
        }
    }

如果您只需要一个额外的非默认标头，您只需使用：

request.Headers.Add("X-Version","1")

更多帮助： How to add request headers when using HttpClient