Routing z wieloma parametrami przy użyciu ASP.NET MVC

Nasza firma rozwija API dla naszych produktów i myślimy o wykorzystaniu ASP.NET MVC. Projektując nasze API, zdecydowaliśmy się na użycie wywołań takich jak to poniżej, aby użytkownik zażądał informacji z API w formacie XML:

http://ws.audioscrobbler.com/2.0/?method=artist.getimages&artist=cher&api_key=b25b959554ed76058ac220b7b2e0a026

Jak widać, przekazywanych jest wiele parametrów (tj. artistI api_key). W ASP.NET MVC, artistbyłoby controller, getImagesdziałania, ale jak chciałbym przekazać wiele parametrów do działania?

Czy jest to w ogóle możliwe przy użyciu powyższego formatu?

Parametry są bezpośrednio obsługiwane w MVC, po prostu dodając parametry do metod akcji. Biorąc pod uwagę akcję podobną do poniższej:

public ActionResult GetImages(string artistName, string apiKey)

MVC automatycznie wypełni parametry po otrzymaniu adresu URL, takiego jak:

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

Dodatkowym specjalnym przypadkiem są parametry o nazwie „id”. Dowolny parametr o nazwie ID można umieścić w ścieżce, a nie w zapytaniu, więc coś takiego:

public ActionResult GetImages(string id, string apiKey)

zostanie poprawnie wypełniony adresem URL takim jak ten:

/Artist/GetImages/cher?apiKey=XXX

Ponadto, jeśli masz bardziej skomplikowane scenariusze, możesz dostosować reguły routingu, których MVC używa do lokalizowania akcji. Twój plik global.asax zawiera reguły routingu, które można dostosować. Domyślnie reguła wygląda następująco:

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

Jeśli chcesz obsługiwać adres URL, taki jak

/Artist/GetImages/cher/api-key

możesz dodać trasę taką jak:

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

i metodę taką jak w pierwszym przykładzie powyżej.

Począwszy od MVC 5, możesz również użyć routingu atrybutów, aby przenieść konfigurację parametrów adresu URL do kontrolerów.

Szczegółowa dyskusja jest dostępna tutaj: http://blogs.msdn.com/b/webdev/archive/2013/10/17/attribute-routing-in-asp-net-mvc-5.aspx

Podsumowanie:

Najpierw włącz routing atrybutów

 public class RouteConfig 
 {
     public static void RegisterRoutes(RouteCollection routes)
     {
         routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

         routes.MapMvcAttributeRoutes();
     } 
 }

Następnie możesz użyć atrybutów do zdefiniowania parametrów i opcjonalnie typów danych

public class BooksController : Controller
{
    // eg: /books
    // eg: /books/1430210079
    [Route("books/{isbn?}")]
    public ActionResult View(string isbn)

Możesz przekazać dowolne parametry przez ciąg zapytania, ale możesz również skonfigurować niestandardowe trasy, aby obsłużyć je w sposób REST:

http://ws.audioscrobbler.com/2.0/?method=artist.getimages&artist=cher&
                                  api_key=b25b959554ed76058ac220b7b2e0a026

To mogłoby być:

routes.MapRoute(
    "ArtistsImages",
    "{ws}/artists/{artist}/{action}/{*apikey}",
    new { ws = "2.0", controller="artists" artist = "", action="", apikey="" }
    );

Więc jeśli ktoś skorzystał z następującej trasy:

ws.audioscrobbler.com/2.0/artists/cher/images/b25b959554ed76058ac220b7b2e0a026/

To doprowadziłoby ich do tego samego miejsca, co twój przykładowy querystring.

Powyższe jest tylko przykładem i nie stosuje reguł biznesowych i ograniczeń, które musisz skonfigurować, aby upewnić się, że ludzie nie „włamują” adresu URL.