Gewusst wie: übergeben/empfangen, mehrere Argumente zu einem RESTful-Web-API-GET-Methode?

Den üblichen Beispiele finden Sie Erholsamen Methoden, die einen parameter (Rückgabe eines skalaren Wert eher als ein Datensatz) angezeigt etwa so:

public string Get(int id)
{
    //get and return the value
}

...wo das val übergeben ist in der Regel eine ID, so können Sie es verwenden, um einen skalaren Wert, basierend auf den einzigartigen Wert.

Was aber, wenn Sie übergeben möchten mehrere Werte, wie ein string und ein int? Ist es einfach eine Sache der Definition einer Methode in etwa so:

public string Get(string someString, int someInt)
{
    //get and return the value
}

...und nannte es so: 

//const string uri = "http://192.112.183.42:80/api/platypusItems/someString/someInt";, zB:
const string uri = "http://192.112.183.42:80/api/platypusItems/DuckbilledPlatypisAreGuysToo/42";
var webRequest = (HttpWebRequest) WebRequest.Create(uri);

?

IOW, wird der routing-Mechanismus herauszufinden, dass da zwei Argumente übergeben werden, sollte es die Get () - Methode mit zwei args ("convention over configuration"), oder gibt es noch mehr, was getan werden muss, um die route, die Dinge richtig?

InformationsquelleAutor B. Clay Shannon | 2013-11-10
  1. 17

    Wenn Sie Web API 2, dann können Sie Attribut-Routing-route-requests wie http://192.112.183.42:80/api/platypusItems/DuckbilledPlatypisAreGuysToo/42

    public class ItemsController : ApiController
{ 
    [Route("api/{controller}/{id}")]
    public string GetItemById(int id)
    {
         //Find item here ...

         return item.ToString();
    }

    [Route("api/{controller}/{name}/{id}")]
    public string GetItemByNameAndId(string name, int id)
    {
         //Find item here ...

         return item.ToString();
    }

}

    http://192.112.183.42:80/api/platypusItems/DuckbilledPlatypisAreGuysToo/42 zugeordnet werden GetItemByNameAndId während http://192.112.183.42:80/api/platypusItems/42 zugeordnet werden GetItemById.

    Beachten Sie, dass Sie brauchen, um zu aktivieren Attribut-routing in der Konfiguration wie diese:

    public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.MapHttpAttributeRoutes();

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

    Aber generell sollte man Argumente übergeben, die als zusätzliche Parameter. Es ist besonders einfach mit GET-Anfragen. Dies funktioniert in Web-API-1&2:

    public class ItemsController : ApiController
{
    public string GetItemById(int id)
    {
         //Find item here ...

         return item.ToString();
    }

    public string GetItemByNameAndId(string name, int id)
    {
         //Find item here ...

         return item.ToString();
    }
}

    Angenommen, Sie haben Standard-mapping-Konfiguration http://192.112.183.42:80/api/platypusItems/42 zugeordnet werden GetItemById während http://192.112.183.42:80/api/platypusItems/42?name=DuckbilledPlatypisAreGuysToo zugeordnet werden GetItemByNameAndId weil Web-API können die Karte 2 Parameter statt 1 für GetItemById.

    Mehr Informationen finden Sie in Mike Wasson Artikel auf Attribut-Routing, Routing-und Action Auswahl und Routing in Web API.

    • Wie kann ich einen JQuery-AJAX-Aufruf, ohne den preflight-Fehler? Dank
    • Siehe hier, wie zu aktivieren CORS
    • Danke. Ich war in der Lage zu aktivieren CORS aber das hinzufügen einer header ist, was das Problem verursacht.
    InformationsquelleAutor Nikolai Samteladze
Schreibe einen Kommentar