ASP.NET Web Api Routing Customization

Question

I have WebApi controllers that end with the "Api" suffix in their names (For ex: StudentsApiController, InstructorsApiController). I do this to easily differentiate my MVC controllers from WebApi controllers. I want my WebApi routes to look similar to

http://localhost:50009/api/students/5 and not http://localhost:50009/api/studentsapi/5.

Currently to achieve this, I am setting up routes like

routes.MapHttpRoute(
name: "GetStudents",
routeTemplate: "api/students/{id}",
defaults: new { controller = "StudentsApi", id = RouteParameter.Optional });

routes.MapHttpRoute(
name: "GetInstructors",
routeTemplate: "api/instructors/{id}",
defaults: new { controller = "InstructorsApi", id = RouteParameter.Optional });

This is turning out to be very cumbersome as I have to add a route for each method in my controllers. I am hoping there should be an easy way to setup route templates that automatically adds the "api" suffix the controller name while processing routes.

score 9 · Answer 1 · answered Jan 28 '13 at 21:17

Following @Youssef Moussaoui's direction I ended up writing the following code that solved the problem.

public class ApiControllerSelector : DefaultHttpControllerSelector
{
    public ApiControllerSelector(HttpConfiguration configuration)
        : base(configuration)
    {
    }

    public override string GetControllerName(HttpRequestMessage request)
    {
        if (request == null)
            throw new ArgumentNullException("request");

        IHttpRouteData routeData = request.GetRouteData();

        if (routeData == null)
            return null;

        // Look up controller in route data
        object controllerName;
        routeData.Values.TryGetValue("controller", out controllerName);

        if (controllerName != null)
            controllerName += "api";

        return (string)controllerName;
    }
}

And register it in Global.asax as

GlobalConfiguration.Configuration.Services.Replace(typeof(IHttpControllerSelector),
            new ApiControllerSelector(GlobalConfiguration.Configuration));

muruge, this would be much easier if you just call base.GetControllerName and then add "api" to it. But that's the right idea. Glad to see this worked out :) — Youssef Moussaoui, Jan 29 '13 at 01:33
I agree, that would be much cleaner. Didn't strike to me. :) — muruge, Jan 29 '13 at 16:34
I must be missing something, this is not working for me. I see my controller selector getting called and it's returning with api at the end but my controller never gets called. — Aaron Stainback, Nov 12 '13 at 02:55

score 8 · Answer 2 · answered May 07 '14 at 00:27

Now that ASP.NET Web API 2 is out, there is a much less cumbersome way to do more complex routing like that you suggested, by using attribute routing.

At the top of your controller just add the following attribute:

[RoutePrefix("api/students")]
public class StudentsApiController : ApiController
{
    ...
}

And then before each API method:

[Route("{id}"]
public HttpResponseMessage Get(int id)
{
    ...
}

There is a bit of setup required, but the positives of doing routing this way are many. For one, you can put the routing with the controllers and methods that do the actual work, so you're never searching around wondering if you have the right route. Secondly and more importantly, it's much easier to do more complex routing, like having the controller name different from the route name (like you want) or having very complex patterns to match against.

It still needs the "Controller" suffix with attribute routing. — angularsen, Jun 29 '15 at 15:17

score 7 · Accepted Answer · answered Jan 23 '13 at 17:16

7

I think the extensibility point you're looking for is the controller selector. You can create a class that derives from DefaultHttpControllerSelector and overrides the GetControllerName to strip out the "api" part. You can then register this controller selector on your service's configuration Services.

answered Jan 23 '13 at 17:16

Youssef Moussaoui

12,187
2
41
37

Sounds like a good place to look into. I will give that a shot and let you know how that goes. – muruge Jan 23 '13 at 20:19

score 1 · Answer 4 · answered Jul 17 '15 at 06:53

Following Youssef's comment on muruug's answer would look something like this

public class ApiControllerSelector : DefaultHttpControllerSelector
{
    public ApiControllerSelector (HttpConfiguration configuration) : base(configuration) { }

    public override string GetControllerName(HttpRequestMessage request)
    {
        return base.GetControllerName(request) + "api";
    }
}

ASP.NET Web Api Routing Customization

4 Answers4

Linked