ASP.NET WebApi custom route

Question

I have a simple Controller that is returning thumbnails, it is defined like:

public class ThumbnailsController : ApiController
{
    public HttpResponseMessage Get(string id)
    {
        //code here
    }
}

Everything works fine, I can access image using url http://site.com/api/Thumbnails/mylogin

But I would like to modify this method like so:

public class ThumbnailsController : ApiController
{
    public HttpResponseMessage Get(string login="", int size=64)
    {
        //code here
    }
}

Idea is to be able to call:
- http://site.com/api/Thumbnails/ - this will return current logged in user picture in default (64x64) size
- http://site.com/api/Thumbnails/mylogin - this will return mylogin user picture in default (64x64) size
- http://site.com/api/Thumbnails/mylogin/128 - this will return mylogin user picture in 128x128 size

My problem are routes, default route works with my unchanged method, but how should I change the default to get this working?

I will also have other Api Controllers but only this one should have custom route.

Here is my attempt, but it isn't working.

routes.MapHttpRoute(
            name: "Thumbnails",
            routeTemplate: "api/thumbnails/{login}/{size}",
            defaults: new {controller="Thumbnails", action="Get", login = RouteParameter.Optional, size = RouteParameter.Optional }
            );

EDIT This is my Controller with test method:

public class ThumbnailsController : ApiController
{
    public string Get(string login="", int size=64)
    {
        return string.Format("login: {0}, size: {1}", login, size);
    }
}

and here is my RouteConfig:

public class RouteConfig
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            name: "Default",
            url: "{controller}/{action}/{id}",
            defaults: new {controller = "Home", action = "Index", id = UrlParameter.Optional}
            );

        routes.MapHttpRoute(
            name: "Thumbnails",
            routeTemplate: "api/Thumbnails/{login}/{size}",
            defaults: new { controller = "Thumbnails" , login = RouteParameter.Optional, size = RouteParameter.Optional }
            );
    }
}

Jon Susiak · Accepted Answer · 2013-10-15 10:25:34Z

7

Make sure you declare your custom route before the default route in the WebApiConfig. EDIT:

public static void Register(HttpConfiguration config)
{
    config.Routes.MapHttpRoute(
    name: "Thumbnails",
    routeTemplate: "api/Thumbnails/{login}/{size}",
    defaults: new { controller = "Thumbnails", action = "Get", 
        login = RouteParameter.Optional, size = RouteParameter.Optional }
    );

    config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
    );
}

edited Oct 15, 2013 at 10:25

answered Oct 15, 2013 at 10:00

Jon Susiak

4,9781 gold badge34 silver badges39 bronze badges

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

4 Comments

Misiu Over a year ago

I didn't declare default route, just this, as for now I have only this Web API controller

Jon Susiak Over a year ago

I've replicated your code and everything appears to be working here. Are you getting an error message or are your calls just not hitting the controller?

Misiu Over a year ago

My parameters aren't passed to method, it is getting defaults. I'll modify my question and I'll add test method

Jon Susiak Over a year ago

Your custom api route should be declared in the WebApiConfig and NOT the RouteConfig. Also as previously stated, it needs to be the first route declared (i.e. BEFORE the default route that is automatically added).

Wahid Bitar · Accepted Answer · 2013-10-15 10:17:27Z

1

The custom route should be before the default one public static void RegisterRoutes(RouteCollection routes) { routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    routes.MapHttpRoute(
        name: "Thumbnails",
        routeTemplate: "api/Thumbnails/{login}/{size}",
        defaults: new { controller = "Thumbnails" , login = RouteParameter.Optional, size = RouteParameter.Optional }
        );

    routes.MapRoute(
        name: "Default",
        url: "{controller}/{action}/{id}",
        defaults: new {controller = "Home", action = "Index", id = UrlParameter.Optional}
        );
}

And try to change the type of the "size" to nullable integer:

public HttpResponseMessage Get(string login = null, int? size = 64)

answered Oct 15, 2013 at 10:17

Wahid Bitar

14.1k13 gold badges83 silver badges109 bronze badges

1 Comment

Misiu Over a year ago

Thanks for help, It's shame that I cant make more that one answer as correct, but @Jonny's comment about route declaration solved my problem.

Collectives™ on Stack Overflow

ASP.NET WebApi custom route

2 Answers 2

4 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related