ASP.NET MVC5/6 Routing based on Http Header values

Question

Let's say I have a most basic controller

public class HomeController : Controller
{
    public ActionResult Index(string id, string language)
    {
        return View();
    }
}

Which takes in 2 parameters. However there is one requirement that the client which calls the action method should pass id value from URL but language value from http header. It means the url should be /Home/Index/12345 and meanwhile the calling client will set a Http Header value language : en.

How shall I set the routing in MVC5 or MVC6 to achieve the requirement?

Please don't provide samples from Web Api.

Thanks

Have you checked the FromHeaderAttribute? Try adding it to the language parameter as in public ActionResult Index(string id, [FromHeader] string language) — Daniel J.G.
– Daniel J.G., Commented Jul 16, 2015 at 16:45
I never notice this attribute. But when I Google the attribute I barely see any further information other than the github page you gave me. — hardywang
– hardywang, Commented Jul 16, 2015 at 16:52
That "github page" is the official Microsoft repo for the new MVC framework :). But yes, documentation is scarce at the moment, hopefully they will improve it over time — Daniel J.G.
– Daniel J.G., Commented Jul 16, 2015 at 16:54

Daniel J.G. · Accepted Answer · 2016-09-25 20:59:09Z

10

There is an attribute FromHeaderAttribute. From its documentation:

Specifies that a parameter or property should be bound using the request headers.

You should be able to add it to the language parameter of your controller. By default it will look for a header with the same name than the parameter, but it also has a name parameter that can be used to specify a different name, for example:

public ActionResult Index(string id, [FromHeader(Name="Accept-Language")]string language)
{
    return View();
}

You can also have a look to the test site ModelBindingWebSite located in the github MVC repo. Check the controller named FromHeader_BlogController.

PS Looking at the source code of the HeaderModelBinder it seems this can be used for binding strings and arrays (assuming the header has a comma separated list of values)

edited Sep 25, 2016 at 20:59

answered Jul 16, 2015 at 16:52

Daniel J.G.

35.2k9 gold badges117 silver badges115 bronze badges

Sign up to request clarification or add additional context in comments.

7 Comments

hardywang Over a year ago

Great for the sample, I will give it and let you know the result.

hardywang Over a year ago

I checked the source code of the attribute, it seems that it is difficult to extend. For example what about the http header is Accepted-Language, I cannot have a parameter name like it. So preferably I should be able to use [FromHeader("Accepted-Language")] to specify which http header value to bind from.

Daniel J.G. Over a year ago

The attribute has a "Name" parameter, have you tried [FromHeader(Name = "Accepted-Language")]? In the sampes website they have a similar case public object BindToStringParameterWithCustomName([FromHeader(Name = "tId")] string transactionId)

hardywang Over a year ago

Great, how can I miss it!!

Stefan Steiger Over a year ago

The header-name is Accept-Language, not Accepted-Language. Otherwise correct.

|

Community · Accepted Answer · 2017-05-23 12:26:00Z

0

As Daniel J.G. said, you can bind a Controller action parameter with FromHeaderAttribute. But keep in mind that a Controller can access Request.Headers directly. It might be nicer to leave off the Controller's language parameter and access the value as an enumeration via a property:

  public enum LanguageType
  {
     Unknown = -1,
     English,
     Spanish,
     German,
     Chinese
  }

  public LanguageType Language
  {
     get
     {
        string langStr = Request.Headers["Accept-Language"];
        switch (langStr.ToLower())
        {
           case "english":
              return LanguageType.English;
           case "spanish":
              return LanguageType.Spanish;
           case "german":
              return LanguageType.German;
           case "chinese":
              return LanguageType.Chinese;
           default:
              return LanguageType.Unknown;
        }
     }
  }

edited May 23, 2017 at 12:26

CommunityBot

11 silver badge

answered Jul 20, 2015 at 19:51

jltrem

12.6k4 gold badges43 silver badges50 bronze badges

2 Comments

Stefan Steiger Over a year ago

The header-name is Accept-Language, not Accepted-Language; Please don't copy-paste other people's mistakes without thinking.

jltrem Over a year ago

@StefanSteiger thanks for your comment! The header spelling is now corrected.

Collectives™ on Stack Overflow

ASP.NET MVC5/6 Routing based on Http Header values

2 Answers 2

7 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

7 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related