Get URL z nazwami ApiController i działania, w projekcie zawierającym Kontrolery i ApiControllers

Question

Istniejący projekt ma sterowników, które dziedziczą z albo:

• Controller: RouteTable.Routes.MapRoute z "{controller}/{action}/{id}".
• ApiController: GlobalConfiguration.Configure oraz w oddzwonieniu MapRoute z "api/{controller}/{id}".

Wszystko działa dobrze, ale muszę wygenerować adresy URL dla metod działania w obu tych typach kontrolerów. Biorąc pod uwagę:

1. nazwę lub typ kontrolera, która dziedziczy z jednej z nich, a
2. nazwa metody działania

Wtedy od strony witryny internetowej, w jaki sposób mogę wygenerować odpowiednie adresy URL strona interfejsu API sieci?

Używam refleksji, aby uzyskać nazwy akcji i kontrolerów już teraz, a następnie poprzez użycie UrlHelper.Action(actionName, controllerName, routeValueDictionary) otrzymuję poprawny adres URL dla tras witryny internetowej.

Jednak ta metoda (oczywiście) generuje adresy URL takie jak dla strony WebAPI: /ApiControllerName/Get?parameter1=value, kiedy musi być /api/ApiControllerName?parameter1=value i osobna wiedza, że ​​jest to żądanie GET.

Cel: jest to strona z testem dymu dla strony internetowej, która używa atrybutów i refleksji, aby zdecydować, co testować. Byłoby miło móc używać tego samego atrybutu w całym projekcie, a ponadto byłoby bardzo miło móc użyć poprawnego UrlHelper, który zna tabele routingu i może wytworzyć właściwy prefiks, taki jak /api/, zamiast kod zakładający, być może błędnie, że trasy API zostały zarejestrowane pod numerem api, a nie, powiedzmy, webapi.

Aktualizacja

Po kontynuacji badań znalazłem the Url.HttpRouteUrl method które mogą generować WebAPI adresy URL, ale wymaga to znając nazwę trasy, a nie nazwa metody działania.

Zrobiłem jeszcze więcej badań na ten temat i nie zbliżyłem się do rozwiązania. Wygląda na to, że znasz nazwę trasy odpowiedniej trasy, you can cook up a Url easily. Istnieją również pewne prawdopodobne wskazówki: here i here. Ale jeśli istnieje wiele tras dla WebApi, skąd wiadomo, który pasuje do kontrolera i działania, które chcesz? Byłoby głupie, by ponownie wprowadzić w życie to, co MVC już robi, wybierając kontroler i działanie. Myślę, że mógłbym stworzyć adres URL z podanych parametrów przy użyciu każdej trasy WebApi, a następnie uruchomić adres URL za pomocą jego kroków (używając niektórych z powyższych linków) i sprawdzić, czy pasuje do pożądanego kontrolera ... fuj.

Musi być łatwiejszy sposób.

Na razie będę musiał przejść, ale mam nadzieję, że ktoś mi pomoże.

Answer 1

Oto kilka sposobów zrobić:

• Korzystanie RouteUrl() metodę:

  var url1 = Url.RouteUrl(new { id = 1, controller = "...", httproute = true }); 
  

Sztuką jest oczywiście httproute = true. Ustawiając tę ​​właściwość, informujesz, że chcesz tylko tras http (trasy Web Api).

• Korzystanie HttpRouteUrl() metody:

  var url2 = Url.HttpRouteUrl(null, new { id = 2, controller = ".." }); 
  

• a inny sposób to zrobić korzystając bezpośrednio z trasy i httproute wartość:

  var values = new RouteValueDictionary(new 
  { 
      id = 3, 
      controller = "...", 
      httproute = true 
  }); 
  var url3 = RouteTable.Routes.GetVirtualPath(Request.RequestContext, values).VirtualPath; 
  

Do 3 sposoby są zasadniczo takie same . Ponieważ nie określisz trasy, system spróbuje znaleźć pierwsze dopasowanie zgodnie z wartościami trasy. Na przykład, powiedzmy, że masz ApiController nazywa RestfulController i Web API trasy są skonfigurowane w taki sposób:

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

Korzystanie z pierwszej metody, kiedy robisz var url = Url.RouteUrl(new { id = 123, controller = "restful", httproute = true }); w MVCController wartość w url jest /api/restful/123.

Ale jeśli dodać nową trasę ConstraintApi:

config.Routes.MapHttpRoute(
    name: "ConstraintApi", 
    routeTemplate: "api2/{controller}/{id}", 
    defaults: new { id = RouteParameter.Optional }, 
    constraints: new { controller = "restful" } 
); 

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

Adres URL jest zwracany przez RouteUrl/api2/restful/123.

Powinieneś znać kolejność zgłaszania tras. Jeśli przed trasą ConstraintApi zostanie dodana trasa DefaultApi, wygenerowany adres URL to /api/restful/123.

Answer 2

Istnieje biblioteka Hyprlinkr, która umożliwia tworzenie identyfikatorów URI z kontrolera i działania przy użyciu konfiguracji trasy.

Answer 3

To wydaje się bardziej jak hak, ale warto spróbować, jeśli planujesz go użyć tylko do testowania. Jak wspomniano, możesz wygenerować adres URL z nazwą trasy. Możesz więc pobrać wszystkie nazwy tras i wygenerować wszystkie możliwe adresy URL. Następnie musisz sprawdzić, czy URL odpowiada na akcję, której potrzebujesz, czy nie. Do tego możesz użyć czegoś takiego: https://stackoverflow.com/a/19382567/1410281. Podstawową ideą jest to, że jeśli masz adres URL, wykonaj fałszywe przekierowanie i pobierz dane routingu z frameworka.