Routing with multiple Get methods in ASP NET Web API

Question

I am using Web Api with ASP NET MVC  and I am very new to it  I have gone through some demo on asp net website and I am trying to do the following   I have 4 get methods  with the following signatures  public List lt Customer gt  Get            gets all customer    public List lt Customer gt  GetCustomerByCurrentMonth            gets some customer on some logic    public Customer GetCustomerById string id           gets a single customer using id    public Customer GetCustomerByUsername string username           gets a single customer using username     For all the methods above I would like to have my web api somewhat like as shown below   List Get     api customers  Customer GetCustomerById string Id    api customers 13 List GetCustomerByCurrentMonth      customers currentMonth Customer GetCustomerByUsername string username     customers customerByUsername yasser   I tried making changes to routing  but as I am new to it  could nt understand much   So  please can some one help me understand and guide me on how this should be done  Thanks

User · Accepted Answer

From here Routing in Asp net Mvc 4 and Web Api  Darin Dimitrov has posted a very good answer which is working for me   It says     You could have a couple of routes   public static class WebApiConfig       public static void Register HttpConfiguration config                config Routes MapHttpRoute              name   ApiById               routeTemplate   api  controller   id                defaults  new   id   RouteParameter Optional                constraints  new   id       0-9                           config Routes MapHttpRoute              name   ApiByName               routeTemplate   api  controller   action   name                defaults  null              constraints  new   name       a-z                           config Routes MapHttpRoute              name   ApiByAction               routeTemplate   api  controller   action                defaults  new   action    Get

User · Answer

using Routing Models  using System  using System Collections Generic  using System Linq  using System Net  using System Net Http  using System Web Http   namespace Routing Controllers       public class StudentsController   ApiController               static List lt Students gt  Lststudents                 new List lt Students gt      new Students   id 1  name  kim                new Students   id 2  name  aman                 new Students   id 3  name  shikha                 new Students   id 4  name  ria                 HttpGet          public IEnumerable lt Students gt  getlist                         return Lststudents                      HttpGet          public Students getcurrentstudent int id                        return Lststudents FirstOrDefault e   gt  e id    id                      HttpGet           Route  api Students  id  course            public IEnumerable lt string gt  getcurrentCourse int id                        if  id    1                  return new List lt string gt       emgili    hindi    pun                 if  id    2                  return new List lt string gt       math                 if  id    3                  return new List lt string gt       c     webapi                 else return new List lt string gt                             HttpGet           Route  api students  id   name             public IEnumerable lt Students gt  getlist int id  string name            return Lststudents Where e   gt  e id    id  amp  amp  e name    name  ToList                HttpGet          public IEnumerable lt string gt  getlistcourse int id  string name                        if  id    1  amp  amp  name     kim                   return new List lt string gt       emgili    hindi    pun                 if  id    2  amp  amp  name     aman                   return new List lt string gt       math                 else return new List lt string gt       no data

User · Answer

I have two get methods with same or no parameters    Route  api ControllerName FirstList     HttpGet  public IHttpActionResult FirstList         Route  api ControllerName SecondList     HttpGet  public IHttpActionResult SecondList         Just define custom routes in AppStart  gt WebApiConfig cs    under register method  config Routes MapHttpRoute         name   GetFirstList          routeTemplate   api Controllername FirstList                      config Routes MapHttpRoute         name   GetSecondList          routeTemplate   api Controllername SecondList

User · Answer

There are lots of good answers already for this question  However nowadays Route configuration is sort of  deprecated   The newer version of MVC   NET Core  does not support it  So better to get use to it     So I agree with all the answers which uses Attribute style routing  But I keep noticing that everyone repeated the base part of the route  api       It is better to apply a  RoutePrefix  attribute on top of the Controller class and don t repeat the same string over and over again    RoutePrefix  api customers    public class MyController   Controller     HttpGet   public List lt Customer gt  Get           gets all customer logic       HttpGet    Route  currentMonth     public List lt Customer gt  GetCustomerByCurrentMonth             gets some customer        HttpGet    Route   id      public Customer GetCustomerById string id         gets a single customer by specified id      HttpGet    Route  customerByUsername  username      public Customer GetCustomerByUsername string username           gets customer by its username

User · Answer

You might not need to make any change in the routing  Just add following four methods in your customersController cs file   public ActionResult Index        public ActionResult currentMonth        public ActionResult customerById int id        public ActionResult customerByUsername string userName        Put the relevant code in the method  With the default routing supplied  you should get appropriate action result from the controller based on the action and parameters for your given urls   Modify your default route as   routes MapRoute       Default      Route name       controller   action   id       URL with parameters     new   controller    Api   action    Index   id   UrlParameter Optional      Parameter defaults

User · Answer

First  add new route with action on top     config Routes MapHttpRoute             name   ActionApi              routeTemplate   api  controller   action   id               defaults  new   id   RouteParameter Optional                config Routes MapHttpRoute              name   DefaultApi               routeTemplate   api  controller   id                defaults  new   id   RouteParameter Optional                Then use ActionName attribute to map    HttpGet  public List lt Customer gt  Get           gets all customer     ActionName  CurrentMonth    public List lt Customer gt  GetCustomerByCurrentMonth           gets some customer on some logic     ActionName  customerById    public Customer GetCustomerById string id          gets a single customer using id     ActionName  customerByUsername    public Customer GetCustomerByUsername string username          gets a single customer using username

User · Answer

this piece of code in the WebApiConfig cs file or your custom bootstrap application class      define two types of routes 1  DefaultActionApi  and 2  DefaultApi as below     config Routes MapHttpRoute  DefaultActionApi    api  controller   action   id    new   id   RouteParameter Optional        config Routes MapHttpRoute  DefaultApi    api  controller   id    new   action    Default   id   RouteParameter Optional           decorate the controller action method with  ActionName  Default    which need to invoked with below url      http   localhost XXXXX api Demo  -- will invoke the Get method of Demo controller      http   localhost XXXXX api Demo GetAll -- will invoke the GetAll method of Demo controller      http   localhost XXXXX api Demo GetById -- will invoke the GetById method of Demo controller      http   localhost 57870 api Demo CustomGetDetails -- will invoke the CustomGetDetails method of Demo controller      http   localhost 57870 api Demo DemoGet -- will invoke the DemoGet method of Demo controller    public class DemoController   ApiController           Mark the method with ActionName  attribute  defined in MapRoutes        ActionName  Default        public HttpResponseMessage Get                 return Request CreateResponse HttpStatusCode OK   Get Method               public HttpResponseMessage GetAll                 return Request CreateResponse HttpStatusCode OK   GetAll Method               public HttpResponseMessage GetById                 return Request CreateResponse HttpStatusCode OK   Getby Id Method                 Custom Method name      HttpGet      public HttpResponseMessage DemoGet                 return Request CreateResponse HttpStatusCode OK   DemoGet Method                 Custom Method name      HttpGet      public HttpResponseMessage CustomGetDetails                 return Request CreateResponse HttpStatusCode OK   CustomGetDetails Method

User · Answer

After reading lots of answers finally I figured out    First  I added 3 different routes into WebApiConfig cs  public static void Register HttpConfiguration config           Web API configuration and services         Web API routes     config MapHttpAttributeRoutes         config Routes MapHttpRoute          name   ApiById           routeTemplate   api  controller   id            defaults  new   id   RouteParameter Optional            constraints  new   id       0-9                   config Routes MapHttpRoute          name   ApiByName           routeTemplate   api  controller   action   name            defaults  null          constraints  new   name       a-z                   config Routes MapHttpRoute          name   ApiByAction           routeTemplate   api  controller   action            defaults  new   action    Get               Then  removed ActionName  Route  etc   from the controller functions  So basically this is my controller      GET  api Countries 5  ResponseType typeof Countries       ActionName  CountryById    public async Task lt IHttpActionResult gt  GetCountries int id        Countries countries   await db Countries FindAsync id       if  countries    null                return NotFound               return Ok countries         GET  api Countries tur    ResponseType typeof Countries         Route  api CountriesByName  anyString          ActionName  CountriesByName       HttpGet   ResponseType typeof Countries       ActionName  CountryByName    public async Task lt IHttpActionResult gt  GetCountriesByName string name        var countries   await db Countries              Where s  gt s Country ToString   StartsWith name                ToListAsync         if  countries    null                return NotFound               return Ok countries       Now I am able to run with following url samples with name and with id    http   localhost 49787 api Countries GetCountriesByName France  http   localhost 49787 api Countries 1

User · Answer

Only one route enough for this  config Routes MapHttpRoute  DefaultApiWithAction     controller   action       And need to specify attribute HttpGet or HttpPost in all actions    HttpGet  public IEnumerable lt object gt  TestGet1         return new string      value1    value2         HttpGet  public IEnumerable lt object gt  TestGet2         return new string      value3    value4

User · Answer

Also you will specify route on action for set route    HttpGet   Route  api customers     public List lt Customer gt  Get          gets all customer logic     HttpGet   Route  api customers currentMonth    public List lt Customer gt  GetCustomerByCurrentMonth            gets some customer      HttpGet   Route  api customers  id     public Customer GetCustomerById string id        gets a single customer by specified id    HttpGet   Route  api customers customerByUsername  username     public Customer GetCustomerByUsername string username          gets customer by its username

[c#] Routing with multiple Get methods in ASP.NET Web API

Examples related to c#

Examples related to asp.net-web-api

Examples related to asp.net-web-api-routing