ASP NET Web API Route templates

Question

I have an entity named Agency with following apis

GET     http://localhost:37331/api/agency?start=1&limit=10&status=1
GET     http://localhost:37331/api/agency/2
POST    http://localhost:37331/api/agency 
PUT     http://localhost:37331/api/agency
DELETE  http://localhost:37331/api/agency/4
POST    http://localhost:37331/api/agency/activate/3
POST    http://localhost:37331/api/agency/deactivate/3
GET     http://localhost:37331/api/agency/types

The route templates I used are

        config.Routes.MapHttpRoute(
            name: "ControllerActionIdApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { },
            constraints: new { id = @"\d+" }
        );
        //
        config.Routes.MapHttpRoute(
            name: "ControllerActionApi",
            routeTemplate: "api/{controller}/{action}"
        );
        //
        config.Routes.MapHttpRoute(
            name: "ControllerIdApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { },
            constraints: new { id = @"\d+" }
        );
        //
        config.Routes.MapHttpRoute(
            name: "ControllerApi",
            routeTemplate: "api/{controller}"
        );

Obviously there is ambiguous between the 2nd and 3rd. I do have a workaround that put the id into query string

GET     http://localhost:37331/api/agency?id=2
DELETE  http://localhost:37331/api/agency?id=4

I think there must be smart way. Could you please suggest on this?

Thanks

Can you not just swap the order of your 2nd and 3rd route? They are matched in sequence your constraints: new { id = @"\d+" } on the 3rd on isnt getting a look-in because the 2nd route will always win. — Mark Jones
– Mark Jones, Commented Feb 1, 2013 at 9:59

Mark Jones · Accepted Answer · 2013-02-01 10:15:30Z

7

The routes are matched in sequence. Your constraint: new { id = @"\d+" } on the 3rd route isn't getting a look-in because the 2nd route will always win.

So swap your 2nd and 3rd routes around.

Always put the most selective routes at the top.

    config.Routes.MapHttpRoute(
        name: "ControllerActionIdApi",
        routeTemplate: "api/{controller}/{action}/{id}",
        defaults: new { },
        constraints: new { id = @"\d+" }
    );
    //

    config.Routes.MapHttpRoute(
        name: "ControllerIdApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { },
        constraints: new { id = @"\d+" }
    );
    //
    config.Routes.MapHttpRoute(
        name: "ControllerActionApi",
        routeTemplate: "api/{controller}/{action}"
    );
    //
    config.Routes.MapHttpRoute(
        name: "ControllerApi",
        routeTemplate: "api/{controller}"
    );

edited Feb 1, 2013 at 10:15

answered Feb 1, 2013 at 10:08

Mark Jones

12.2k2 gold badges52 silver badges62 bronze badges

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

Comments

Thilok Gunawardena · Accepted Answer · 2013-02-01 07:23:16Z

0

Try this

routeTemplate: "api/{controller}/{action}/{id}"

answered Feb 1, 2013 at 7:23

Thilok Gunawardena

9245 gold badges22 silver badges44 bronze badges

1 Comment

Botem Bao Over a year ago

It's not work. Generally there are four patterns, your routes only covers one of them. Thanks.

Collectives™ on Stack Overflow

ASP NET Web API Route templates

2 Answers 2

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related