[API Proposal]: Adding headers with a method

[BehtashShirzad]

Background and motivation

Firstly when I had many headers to add for my httpclient defaultHeader, I was adding them in seprate lines, then I looked for a method and I did not find that so I created a method that takes a Dictionary of string and in that method by foreach I added the keys and values to default header.
This approach made my code cleaner.
@karelz

API Proposal

namespace System.Net.Http.System.Net.Http
{
    public static class HttpClientExtensions
    {

        public static Task AddHeader(this HttpClient httpclinet, Dictionary<string, string> dictionary)
        {
            if (dictionary == null)
                return;
            foreach (var item in dictionary)
            {
                if (!client.DefaultRequestHeaders.Contains(header.Key))
                {
                    httpclinet.DefaultRequestHeaders.Add(item.Key, item.Value);
                }
            }
            return Task.CompletedTask;


        }
    }
}

API Usage

using(var client = new HttpClient()){
var headers = new Dictionary<string,string>(){
{"X-Authorization":"abcd"},
{"X-gateway","Payment"}
};
client.AddHeader(headers);
client.post();
}

Alternative Designs

No response

Risks

No response

[dotnet-policy-service]

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

[BehtashShirzad]

@karelz

[BehtashShirzad]

@dotnet/ncl

[huoyaoyuan]

If all your need is to initialize DefaultRequestHeaders with less lines, you can just use the in-place collection initializer syntax when creating the HttpClient:

var c = new HttpClient
{
    DefaultRequestHeaders =
    {
        {"X-Authorization", "abcd"},
        {"X-gateway", "Payment"}
    }
};

The real problem is that HttpHeaders doesn't have AddRange methods, so there's no support for bulk addition afterwards. But you can easily define you own extension method.

This proposal will likely never be considered because it doesn't operate on the correct type.

[BehtashShirzad]

If all your need is to initialize DefaultRequestHeaders with less lines, you can just use the in-place collection initializer syntax when creating the HttpClient:

var c = new HttpClient
{
    DefaultRequestHeaders =
    {
        {"X-Authorization", "abcd"},
        {"X-gateway", "Payment"}
    }
};

The real problem is that HttpHeaders doesn't have AddRange methods, so there's no support for bulk addition afterwards. But you can easily define you own extension method.

This proposal will likely never be considered because it doesn't operate on the correct type.

Consider that the time you recieve the headers from outside of your scope, for example your caller wanna send you that headers.

But I think the best place for this method will be at Header class not that httpclient

[antonfirsov]

Triage: we can consider an AddRange method on HttpHeaders if there are more users asking for it.

[BehtashShirzad]

@antonfirsov Yeah, AddRange is better because of convention and it's place in HttpHeader👍

[bzd3y]

@MDshirzad It being a Dictionary might be tricky because multiple headers with the same field name are allowed. So subsequent calls could certainly enforce the spec. and concatenate the values as a comma-separated list. But the following code represents valid headers but not a valid Dictionary.

	Dictionary<string, string> headers = new()
	{
		["DuplicateHeader"] = "one value",
		["DuplicateHeader"] = "another value"
	}; // would be added as "DuplicateHeader: one value, another value", but the duplicate keys will throw an exception.

So you might want to keep that in mind for your code, especially since you mentioned getting headers from "outside of your scope", which I assume means from a source you don't control.

As for a built in AddRange, that would certainly be useful. I assume it would just take another collection derived from HttpHeaders.