ASP.net WebAPI controller directory/ routing

Question

I am trying to do something similar to what is suggested on this site https://mathieu.fenniak.net/stop-designing-fragile-web-apis/

It suggested that this is a better url

http://api.fbi.gov/wanted/most

My question is how do I do something like that in ASP.NET WEBAPI. For example, if I want to return a specific query of joining some data with another table, instead of passing in a parameter I just want a method url call that just does the one query I want. What is the easiest way to accomplish this task?

example url call:

api/controller/joinresultwithtable2

Darrel Miller · Accepted Answer · 2013-11-19 02:52:05Z

It's not exactly pretty but you can setup routing so a specific path maps to a specific controller and action.

        config.Routes.MapHttpRoute("query1", "query/query1", new {controller="StockQueries", action="query1"});
        config.Routes.MapHttpRoute("query2", "query/query2", new { controller = "StockQueries", action = "query2" });
        config.Routes.MapHttpRoute("query3", "query/query3", new { controller = "StockQueries", action = "query3" });

And then have a controller that looks like this,

public class StockQueriesController : ApiController
{
    [ActionName("query1")]
    public HttpResponseMessage GetQuery1()
    {
        return new HttpResponseMessage() {Content = new StringContent("Query1")};
    }

    [ActionName("query2")]
    public HttpResponseMessage GetQuery2()
    {
        return new HttpResponseMessage() { Content = new StringContent("Query1") };
    }

    [ActionName("query3")]
    public HttpResponseMessage GetQuery3()
    {
        return new HttpResponseMessage() { Content = new StringContent("Query1") };
    }
    [ActionName("query4")]
    public HttpResponseMessage GetQuery4()
    {
        return new HttpResponseMessage() { Content = new StringContent("Query1") };
    }
}

Kenneth · Accepted Answer · 2013-11-18 23:38:46Z

2

The easiest way to go is probably attribute routing. You can find more information here: http://attributerouting.net/

It allows you to declare any route right (with parameters) directly on an action method. That way you can control quite easily how you make your resources available.

In case you want to version your API, it's also quite easy, because you can just include the version in your attribute

answered Nov 18, 2013 at 23:38

Kenneth

28.8k7 gold badges65 silver badges85 bronze badges

Comments

Jon Douglas · Accepted Answer · 2013-11-18 23:47:55Z

2

If you are using ASP.NET Web API 2, you can do the following:

[Route("customers/{customerId}/orders")]
public IEnumerable<Order> GetOrdersByCustomer(int customerId) { ... }

Source: http://www.asp.net/web-api/overview/web-api-routing-and-actions/attribute-routing-in-web-api-2

answered Nov 18, 2013 at 23:47

Jon Douglas

13.2k4 gold badges41 silver badges53 bronze badges

Comments

Shimnas · Accepted Answer · 2016-10-18 11:49:41Z

0

You can also use following method:

[ActionName("DefaultApi")]
[Route("Api/UserLogin/DefaultApi/UserDetails")] 
public IHttpActionResult UserDetails(){
  return Ok(db.UserLogins.ToList());
}

edited Oct 18, 2016 at 11:49

answered Oct 18, 2016 at 11:35

Shimnas

134 bronze badges

Collectives™ on Stack Overflow

ASP.net WebAPI controller directory/ routing

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related