Web api routing methods with different parameter names

Question

This question could have been answered hundred times, but I couldnt find a proper resource. In a WebApi project (default project provided by VS) I have the ValuesController as below.

   public string Get(int id)
    {
        return "value";
    }

    [HttpGet]
    public string FindByName(string name)
    {
        return name;
    }

    [HttpGet]
    public string FindById(int id)
    {
        return id.ToString();
    }

In the WebApiConfig.cs, I have following route mapping.

 config.Routes.MapHttpRoute(
              name: "actionApiById",
              routeTemplate: "api/{controller}/{action}/{Id}",
              defaults: new { action = "FindById", Id = RouteParameter.Optional }
              );


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

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

Now only the FindById() action is working when i try in the browser. Why does the rest of api calls return "No HTTP resource was found that matches the request"

How can I get all three methods working? without using AttributeRouting. Am I lack of basic concepts of web api? ( i think yes)

You mean you are not able to invoek the "Get" method ? If so please share the way you are calling the methods from client side ? — Thanigainathan
– Thanigainathan, Commented Feb 6, 2014 at 4:14

Afazal · Accepted Answer · 2014-09-28 06:33:22Z

4

AS We all know REST is resource based and this identify the resource with the URL, so that not more than one method with same parameter will be allowed in the REST service but there is work around in MVC 5 Web Api method level routing.

Here is the example you can do that:

[HttpGet]
[Route("api/search/FindByName/{name}")]
FindByName(string name)
{
}

[HttpGet]
[Route("api/search/FindById/{name}")]
FindById(int searchId)

Note:"search" is the controller name.

Please let know if need more clarification.

answered Sep 28, 2014 at 6:33

Afazal

5425 silver badges9 bronze badges

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

1 Comment

Hugo Nava Kopp Over a year ago

Yes, I like this solution and is what I have implemented, but I wonder if it is good practice?

Roman Marusyk · Accepted Answer · 2017-07-31 11:50:36Z

3

In general you don't want to have a route per action like your sample suggests. As your app grows this will get quickly out of hand.

Also consider building your url space in a way that will look just RESTfull

So methods will be GetById, GetByName, and then pass the parameters in the query string to match the right action (BTW not sure what the difference in your case is between GetById and FindById if they are not really different consider just keeping one of them around).

You can stick with the default route and your request will look like:

/api/controller/345 or /api/controller?name=UserName or /api/controller?SearchId=345 (assuming search was indeed a different behavior)

Then the method signatures:

Get(int id)
{
}

[HttpGet]
FindByName(string name)
{
}

[HttpGet]
FindById(int searchId)
{
}

edited Jul 31, 2017 at 11:50

Roman Marusyk

24.8k27 gold badges83 silver badges127 bronze badges

answered Feb 6, 2014 at 17:13

Yishai Galatzer

8,8622 gold badges35 silver badges42 bronze badges

Comments

ssilas777 · Accepted Answer · 2014-02-06 04:07:30Z

1

Your actionApiById Route also matches the actionApi route, As your id is integer try using constraint like this.

config.Routes.MapHttpRoute(
              name: "actionApiById",
              routeTemplate: "api/{controller}/{action}/{Id}",
              defaults: new { action = "FindById", Id = RouteParameter.Optional }
              constraints: new {Id = @"\d+" }
              );

answered Feb 6, 2014 at 4:07

ssilas777

9,7704 gold badges48 silver badges70 bronze badges

Collectives™ on Stack Overflow

Web api routing methods with different parameter names

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related