Routing with Multiple Parameters using ASP NET MVC

Question

Our company is developing an API for our products and we are thinking about using ASP NET MVC   While designing our API  we decided to use calls like the one below for the user to request information from the API in XML format   http   ws audioscrobbler com 2 0  method artist getimages amp artist cher amp api key b25b959554ed76058ac220b7b2e0a026  As you can see  multiple parameters are passed  i e  artist and api key    In ASP NET MVC  artist would be the controller  getImages the action  but how would I pass multiple parameters to the action     Is this even possible using the format above

User · Accepted Answer

Parameters are directly supported in MVC by simply adding parameters onto your action methods. Given an action like the following:

public ActionResult GetImages(string artistName, string apiKey)

MVC will auto-populate the parameters when given a URL like:

/Artist/GetImages/?artistName=cher&apiKey=XXX

One additional special case is parameters named "id". Any parameter named ID can be put into the path rather than the querystring, so something like:

public ActionResult GetImages(string id, string apiKey)

would be populated correctly with a URL like the following:

/Artist/GetImages/cher?apiKey=XXX

In addition, if you have more complicated scenarios, you can customize the routing rules that MVC uses to locate an action. Your global.asax file contains routing rules that can be customized. By default the rule looks like this:

routes.MapRoute(
            "Default",                                              // Route name
            "{controller}/{action}/{id}",                           // URL with parameters
            new { controller = "Home", action = "Index", id = "" }  // Parameter defaults
        );

If you wanted to support a url like

/Artist/GetImages/cher/api-key

you could add a route like:

routes.MapRoute(
            "ArtistImages",                                              // Route name
            "{controller}/{action}/{artistName}/{apikey}",                           // URL with parameters
            new { controller = "Home", action = "Index", artistName = "", apikey = "" }  // Parameter defaults
        );

and a method like the first example above.

User · Answer

You can pass arbitrary parameters through the query string  but you can also set up custom routes to handle it in a RESTful way   http   ws audioscrobbler com 2 0  method artist getimages amp artist cher amp                                    api key b25b959554ed76058ac220b7b2e0a026   That could be   routes MapRoute       ArtistsImages         ws  artists  artist   action    apikey        new   ws    2 0   controller  artists  artist       action     apikey               So if someone used the following route   ws audioscrobbler com 2 0 artists cher images b25b959554ed76058ac220b7b2e0a026    It would take them to the same place your example querystring did   The above is just an example  and doesn t apply the business rules and constraints you d have to set up to make sure people didn t  hack  the URL

User · Answer

Starting with MVC 5  you can also use Attribute Routing to move the URL parameter configuration to your controllers   A detailed discussion is available here  http   blogs msdn com b webdev archive 2013 10 17 attribute-routing-in-asp-net-mvc-5 aspx  Summary   First you enable attribute routing   public class RouteConfig          public static void RegisterRoutes RouteCollection routes                  routes IgnoreRoute   resource  axd   pathInfo               routes MapMvcAttributeRoutes                 Then you can use attributes to define parameters and optionally data types  public class BooksController   Controller          eg   books        eg   books 1430210079      Route  books  isbn          public ActionResult View string isbn

[c#] Routing with Multiple Parameters using ASP.NET MVC

Examples related to c#

Examples related to .net

Examples related to asp.net-mvc

Examples related to routing