Mapping HTTP routes in ASP.NET Web API

Question

Let's say I have an app with orders and order details. I am trying to figure out how to best set up the architecture so I can retrieve all order details for a particular order. It would seem elegant and intuitive to have a URL structure like this:

http://example.com/api/orders/{orderid}/orderdetails

I can register a route in global.asax:

System.Web.Routing.RouteTable.Routes.MapHttpRoute(
  name: "DefaultApi",
  routeTemplate: "api/orders/{orderid}/orderdetails",
  defaults: new { orderid = System.Web.Http.RouteParameter.Optional }
);

But I can't figure out what method in the OrdersController class this maps to. What method signature does the above route expect in my controller class? For all I know, this isn't even valid, so feel free to recommend a different approach.

Roger · Accepted Answer · 2012-04-24 15:12:00Z

3

I got it working with the following.

Global.asax Application_Start:

System.Web.Routing.RouteTable.Routes.MapHttpRoute(
 name: "DefaultApi",
 routeTemplate: "api/{controller}/{orderid}/{action}"
);

Controller class:

[ActionName("OrderDetails")]
public IEnumerable<OrderDetail> GetOrderDetails(int orderId)
{
 // return data...
}

answered Apr 24, 2012 at 15:12

Roger

2,3261 gold badge23 silver badges28 bronze badges

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

Comments

Olga Panko · Accepted Answer · 2013-03-21 16:20:18Z

0

Take a look at amazing AttributeRouting.WebAPI package http://www.strathweb.com/2012/05/attribute-based-routing-in-asp-net-web-api/.

answered Mar 21, 2013 at 16:20

Olga Panko

5,4735 gold badges24 silver badges20 bronze badges

Comments

Kumaresan Lc · Accepted Answer · 2013-06-19 10:24:17Z

0

Take a look at the following page. It will be helpful http://aspnetwebstack.codeplex.com/wikipage?title=Attribute%20routing%20in%20Web%20API

answered Jun 19, 2013 at 10:24

Kumaresan Lc

2811 gold badge2 silver badges8 bronze badges

Comments

Rahul Saraswat · Accepted Answer · 2016-05-12 17:57:14Z

0

Add System.Web.Http.WebHost dll reference into your web application. Thank You.

answered May 12, 2016 at 17:57

Rahul Saraswat

1

1 Comment

keithm Over a year ago

This doesn't answer the OP question. He asked which method and signature in the OrdersController class his route maps to.

Collectives™ on Stack Overflow

Mapping HTTP routes in ASP.NET Web API

4 Answers 4

Comments

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related