welcome to XRM blog

Keep in touch with latest CRM/ERP articles

To remain competitive your organisation must be efficient across the business process spectrum. To do so you need to take sound decisions based on a balance between the cost and risk. To do so you will be heavily dependent on your content management in itself needs...

image
Blog

Web API Attribute Routing

By Sudeep on 1/26/2016

 

In my previous post here I had discussed about convention based routing which is the default way in Web API. Check it out here.Starting with Web API 2 Microsoft introduced attribute based routing. Which is way more simpler. The reason for introducing this new feature was two folds, one it is easier to understand and maintain, second is the kind of REST calls required.

Let me elucidate it with an example

GET /profile/20011/ContactNumber

GET /profile/2011/EmailAddress

Not to say that this cannot be achieved by traditional methods but it is much harder to understand.

So Microsoft came up with Attribute Routing.

Let us take an example

So for our first example let us assume that you want the route to read some thing like this

www.mysidye.com/Employee

In this case we use a prefix called [Route(“Employee”)] before the action needed.

Parameter’s in End Point

 

Pretty simple isn’t it? Now let’s say you want the endpoint to be something like this, where 1 is the Id of the Employee, for whom you need the profile.

www.mysidye.com/Profile/56

Using Route Prefix this becomes pretty simple

Now let it take a step further and this time we need all the orders for a particular employee with id 501

www.mysidye.com/Profile/56/Orders

As you can see each parameter is written with curly braces and the function names the parameter exactly the same.

So does that mean we can use only a single parameter? No!

Let’s take another example, I want the order no 345 for the Employee profile with id of 56

www.mysidye.com/Profile/56/Order/345

Parameter Type

If we want to pass some parameter which has a type different from number, can we do it? Yes sure, let me modify the earlier example and get the profile based on name instead of id(not a good idea). Assumption is that name will always be unique and never repeated

www.mysidye.com/Profile/SudeepMukherjee/Order/345

As you can see I have decorated the parameter with the type. It looks fine but there is slight issue with this type, it only accepts alphabets and will fail if you pass a blank space. Please find the table below as a guide for your reference.

It is pretty much impossible to discuss all the options in one article but you can find it out by yourself how to use all of them.

RoutePrefix

Till now we have concentrated on defining the Rest end point based on the action. In our simple scenario it is pretty easy but in real world this is seldom the case. Your project will have multiple controllers and most probably some of them will have over lapping action names, even after you changing the route string.

In such a case we can put the RoutePrefix on top of our class/controller. Continuing from the earlier example let us assume we need the controller name to be part of the Rest endpoint. (Master is the name given to our class)

www.mysidye.com/Master/Profile/SudeepMukherjee/Order/345

HTTP Methods

All the examples shown till now have been simple Get request but WebAPI2 is not restricted to only one verb. Following verbs are available to  you for your usage.

·        [HttpDelete]

·        [HttpGet]

·        [HttpHead]

·        [HttpOptions]

·        [HttpPatch]

·        [HttpPost]

·        [HttpPut]

Let’s assume that you are not following the conventions and the action name does not contain the Http verb, so how do you make Web API understand the verb you are using. Simple!

As you can see I have adorned the top of the action with the verb [HttpPost], this will make the Web API understand this is not a get request but a post request.

I hope I have made a few points clear to you and made the confusing routing a little easy, in my next article I will post a simple JavaScript code to call these webapi’s .

 

.Net
Web API
Author
Blog Calendar
Blog Calendar List
2021 Sep  3  2
2021 Aug  7  4
2021 Jul  12  4
2021 Jun  49  6
2021 May  12  2
2021 Apr  26  3
2021 Mar  30  5
2021 Feb  78  7
2021 Jan  138  9
2020 Dec  62  7
2020 Sep  38  3
2020 Aug  121  3
2020 Jul  68  1
2020 Jun  29  3
2020 Apr  16  3
2020 Mar  11  2
2020 Feb  23  5
2020 Jan  23  7
2019 Dec  15  4
2019 Nov  12  1
2019 Jan  33  3
2018 Dec  36  4
2018 Nov  66  3
2018 Oct  12  3
2018 Sep  463  11
2018 Aug  6  2
2018 Jun  11  1
2018 Jan  58  2
2017 Sep  565  5
2017 Aug  17  1
2017 Jul  17  2
2017 Jun  54  2
2017 May  21  1
2017 Apr  33  2
2017 Mar  120  4
2017 Feb  483  4
2016 Dec  185  3
2016 Nov  449  8
2016 Oct  256  10
2016 Sep  367  6
2016 Aug  39  1
2016 Jun  1797  6
2016 May  104  3
2016 Jan  71  2
2015 Dec  392  6
2015 Nov  4  1
2015 Oct  13  1
2015 Sep  1400  6
2015 Aug  13  1
2015 Jul  127  2
2015 Jun  10  1
2015 May  20  1
2015 Apr  28  3
2015 Mar  78  3
2015 Jan  5284  4
2014 Dec  17  1
2014 Nov  2231  4
2014 Oct  64  1
2014 Sep  106  2
2014 Aug  4880  1
2014 Jul  46  2
2014 Apr  2492  12
2014 Mar  295  19
2014 Feb  241  8
2014 Jan  1510  16
2013 Dec  21  2
2013 Nov  662  2
2013 Oct  252  3
2013 Sep  11  1
2013 Aug  38  3
2013 Jul  209  1
2013 Apr  50  6
2013 Mar  1962  10
2013 Feb  312  4
2013 Jan  273  2
2012 Nov  39  2
2012 Oct  464  10
Tag Cloud
Interested in our services? Still not sure about project details? get a quote