Come creare l'URL API Web ASP.NET?

Question

In ASP.NET MVC, abbiamo @Url.Action per le azioni. C'è qualcosa di simile allo @Url.Api che si dirigerebbe verso/api/controller?

Answer 1

Il ApiController ha una proprietà denominata Url che è di tipo System.Web.Http.Routing.UrlHelper che consente di creare URL per i controller API.

Esempio:

public class ValuesController : ApiController 
{ 
    // GET /api/values 
    public IEnumerable<string> Get() 
    { 
     // returns /api/values/123 
     string url = Url.Route("DefaultApi", new { controller = "values", id = "123" }); 
     return new string[] { "value1", "value2" }; 
    } 

    // GET /api/values/5 
    public string Get(int id) 
    { 
     return "value"; 
    } 

    ... 
} 

Questa UrlHelper non esiste né in vostro punto di vista, né nei controllori standard.

---

UPDATE:

E per fare fuori il routing di un ApiController si potrebbe procedere come segue:

public class HomeController : Controller 
{ 
    public ActionResult Index() 
    { 
     string url = Url.RouteUrl(
      "DefaultApi", 
      new { httproute = "", controller = "values", id = "123" } 
     ); 
     return View(); 
    } 
} 

o all'interno di una vista:

<script type="text/javascript"> 
    var url = '@Url.RouteUrl("DefaultApi", new { httproute = "", controller = "values", id = "123" })'; 
    $.ajax({ 
     url: url, 
     type: 'GET', 
     success: function(result) { 
      // ... 
     } 
    }); 
</script> 

Avviso del httproute = "" token di rotta che è importante.

Ovviamente questo presuppone che il percorso Api si chiama DefaultApi nel metodo RegisterRoutes in Global.asax:

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

Answer 2

Funziona con la forma più semplice di Url.Action quindi non devi fare riferimento a tutti i nomi di routing:

Url.Action("ActionName", "ControllerName", new { httproute = "DefaultApi" }) 

È possibile aggiungere un area = "" se l'URL è necessario all'interno di un'area. (I controller Api sono al di fuori delle aree per impostazione predefinita.) Sto utilizzando MVC 4.

Answer 3

Vuoi essere in grado di generare collegamenti in modo typesable, senza stringhe codificate (nomi controller)?

C'è un nuget per questo!(Ed è scritto da Mark Seeman)

https://github.com/ploeh/Hyprlinkr

funziona così:

Routes, come al solito:

name: "API Default", 
routeTemplate: "api/{controller}/{id}", 
defaults: new { id = RouteParameter.Optional } 

ottenere un URL:

var linker = new RouteLinker(request); 
var uri = linker.GetUri<FooController>(r => r.GetById(1337)); 

Risultato:

http://localhost/api/foo/1337 

Answer 4

Ecco il metodo Kiss per rispondere alla domanda:

Se questo è il codice che si usa per creare un controller URL MVC

@Url.Action("Edit", "MyController") 

Al fine di ottenere un URL per le API versione del controller (supponendo che si utilizza lo stesso nome del controller) è possibile utilizzare

@Url.Action("Edit", "api/MyController") 

Tutto il metodo Url.Action sta facendo è aggiungendo il percorso principale dell'applicazione, con la c nome ontroller, seguito dal nome dell'azione (a meno che non sia "Index", nel qual caso non viene aggiunto. se l'oggetto dei valori di percorso ha una proprietà id, anche il valore viene aggiunto all'URL.