using Web API attribute routing and RoutePrefix

Question

When using web api, how does one call the proper routing methods if you use [RoutePrefix()]

Say you have something like "MyReallyLongNamedClassController". the default route would be http:...com/api/MyReallyLongNamedClass. The application then goes by methods named Get, Post, Put, etc (unless of course using verb decorators).

If I put a route prefix decorator of [RoutePrefix("api/LongClass")] on my controller, how can I have web api still use the defaults for the methods?

Meaning, I want the method named "GetAll()" to still map to "api/LongClass" (when using a get header) and "PostThis(int id)" to still map to "api/LongClass/{id}" (when using a post header)

Benji · Accepted Answer · 2015-02-03 16:59:15Z

6

Here's what I did to solve the problem without having to decorate all methods with annotations. I put RoutePrefix at the class level, as well as the default Route

[RoutePrefix("api/longclass")]
[Route("{id?}")]
public class MyReallyLongNamedClass: ApiController
{

    public string GetAll(int id)
    { 
        return "result";
    }


    public string PostThis([FromBody] MyModel model)
    {
       var res=  _repository.Save(model);
       return res;
    }
}

edited Feb 3, 2015 at 16:59

answered Feb 3, 2015 at 1:34

Benji

5092 gold badges4 silver badges16 bronze badges

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

Comments

AJ Richardson · Accepted Answer · 2015-04-07 19:10:00Z

Another option: if all you want to do is change the controller name in the route, you can create a custom controller selector:

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

    public override string GetControllerName(HttpRequestMessage request)
    {
        var name = base.GetControllerName(request);

        // Interpret "LongClass" as "MyReallyLongNamedClass"
        if (name == "LongClass")
            name = "MyReallyLongNamedClass";

        return name;
    }
}

Then you can register the controller selector in your WebApiConfig.Register:

config.Services.Replace(typeof(IHttpControllerSelector), new CustomControllerSelector(config));

The advantage of this is that you can use your already-mapped routes (defined using HttpRouteCollection.MapHttpRoute()) instead of using attribute routing. However, if you need to use attribute routing for other reasons anyways, then your solution is probably better.

su8898 · Accepted Answer · 2015-01-29 17:27:16Z

0

You don't have to worry about how the RoutePrefix attribute works internally. You can decorate either your controller or actions with RoutePrefix and can call the actions in accordance with your settings. You will have to use the Route atribute in your actions in order for [RoutePrefix] to work properly.

For example, in the below controller, all GET requests to url api/longclass/get will invoke the GetAll method and all POST requests to api/longclass/postwill invoke PostThis

[RoutePrefix("api/longclass")]
public class MyReallyLongNamedClass: ApiController
{
    [Route("get")]
    public string GetAll(int id)
    { 
        return "result";
    }

    [Route("post")] 
    public string PostThis([FromBody] MyModel model)
    {
       var res=  _repository.Save(model);
       return res;
    }
}

edited Jan 29, 2015 at 17:27

answered Jan 29, 2015 at 17:11

su8898

1,72319 silver badges23 bronze badges

2 Comments

Benji Over a year ago

When I do that I get the following error {"Message":"No HTTP resource was found that matches the request URI 'localhost:26308/api/… type was found that matches the controller named 'longclass'."}

Benji Over a year ago

While I did not try your solution to see if it works, I did find another solution that works.I put [RoutePrefix("api/LongClass")] and [Route("{id?}")] at the controller level

Collectives™ on Stack Overflow

using Web API attribute routing and RoutePrefix

3 Answers 3

Comments

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related