Optionaler query-string-Parameter in ASP.NET Web-API

Muss ich die Umsetzung der folgenden WebAPI Methode:

/api/books?author=XXX&title=XXX&isbn=XXX&somethingelse=XXX&date=XXX

Alle query-string-Parameter kann auf null gesetzt werden. Das heißt, die Anrufer geben an, von 0 zu allen 5 Parametern.

In MVC4 beta ich verwendet, um Folgendes zu tun:

public class BooksController : ApiController
{
    //GET /api/books?author=tolk&title=lord&isbn=91&somethingelse=ABC&date=1970-01-01
    public string GetFindBooks(string author, string title, string isbn, string somethingelse, DateTime? date) 
    {
        //...
    }
}

MVC4-RC benimmt sich nicht mehr so. Wenn ich angeben, weniger als 5 Parameter, es antwortet darauf mit einem 404 sagen:

Keine Aktion fand auf dem controller 'Bücher', die der Anfrage entspricht.

Was ist die richtige Methode, die Signatur zu machen, Verhalten sich wie früher, ohne Angabe der optionalen parameter in der URL-routing?

setzen Sie [httpget] auf Aktion.
Wenn ich legen Sie alle Parameter, die die Methode aufgerufen wird; ferner beginnt mit Get so ist es automatisch mit der HTTP GET Methode...
Dies ist, wie web-api-routing funktioniert, asp.net/web-api/overview/web-api-routing-and-actions/...
Ja. Ich weiß, wie es funktioniert. Ich kann einfach nicht damit es funktioniert unter DIESEM besonderen Umstand.
Wie hat sich diese selbst kompilieren? string? ist kein Gültiger Typ. Sie können nicht erklären string als eine null geben, da es ein Referenz-Typ.
Sie haben Recht, es war wohl eine schnelle Kern der code, den ich schrieb, nur für die Zwecke zu verstehen, warum ich war nicht in der Lage, um die Standardeinstellung zu null. Soweit ich mich erinnere, das eigentliche Problem war mit DateTime die nicht vorgegeben werden, bis die beta-Version. Auch diese Frage ist von 1 Jahr und einen halben Tag.

InformationsquelleAutor frapontillo | 2012-08-08

asp.net-web-api c#query-string url

288

Dieses Problem wurde behoben in der regelmäßigen Veröffentlichung von MVC4.
Jetzt können Sie tun:
```
public string GetFindBooks(string author="", string title="", string isbn="", string  somethingelse="", DateTime? date= null) 
{
    //...
}
```
und alles wird funktionieren out of the box.
- Optionale Parameter, löst dieses Problem.
- Kann ich null hier als default? Zum Beispiel: string Autor=null ?
- Ja, null ist als ein konstanter Ausdruck, und daher einen gültige default-Wert.
- Ich Frage mich, warum wir noch erwähnen, default-Werte, auch für optionale Parameter, wie gesagt, hier . Jeder Typ in C# immer ein Standard-Wert, so dass das routing der run-time hätte mit dem Typ Standard-Wert, wenn Sie nicht erhalten, die aus der URI. Was ist der technische Grund dafür?. Ich bin sicher, das hat etwas zu tun mit der Modell-binder.
- Damit kann die route angepasst werden
- Ich war mit Parameter Datum und wenn ich nur setzen Sie Sie auf null-Werte zulässt, nicht funktioniert. Also ich habe es null-Werte zulässt und die null als default-Wert, und verwenden Sie server-seitige Validierung entsprechend und Fehler zurück. Es arbeitete.
InformationsquelleAutor frapontillo
77

Ist es möglich, mehrere Parameter übergeben, wie ein einzelnes Modell als vijay vorgeschlagen. Dies funktioniert für ERHALTEN Sie, wenn Sie die FromUri parameter-Attribut. Dies sagt WebAPI zu füllen, das Modell aus der Abfrage-Parameter.

Das Ergebnis ist ein sauberer controller-Aktion, mit nur einem einzigen parameter. Weitere Informationen finden Sie unter: http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api
```
public class BooksController : ApiController
  {
    //GET /api/books?author=tolk&title=lord&isbn=91&somethingelse=ABC&date=1970-01-01
    public string GetFindBooks([FromUri]BookQuery query)
    {
      //...
    }
  }

  public class BookQuery
  {
    public string Author { get; set; }
    public string Title { get; set; }
    public string ISBN { get; set; }
    public string SomethingElse { get; set; }
    public DateTime? Date { get; set; }
  }
```
Er unterstützt sogar mehrere Parameter, solange die Eigenschaften nicht widersprechen.
```
//GET /api/books?author=tolk&title=lord&isbn=91&somethingelse=ABC&date=1970-01-01
public string GetFindBooks([FromUri]BookQuery query, [FromUri]Paging paging)
{
  //...
}

public class Paging
{
  public string Sort { get; set; }
  public int Skip { get; set; }
  public int Take { get; set; }
}
```
Update:

Um sicherzustellen, dass die Werte optional sind, stellen Sie sicher, zu verwenden, Referenztypen oder nullables (ex. int?) für die Modelle Eigenschaften.
- Ja, aber der [FromUri] decorator allein scheint nicht zu unterstützen optionale Parameter.
- Sie sind korrekt mit [FromUri] nicht direkt die Antwort auf die ursprüngliche Frage. Es sagt grundsätzlich aus, füllen Sie diese Modelle mit den Werten aus der Uri. Die Modelle Eigenschaften müsste null sein oder ein Referenz-Typ, um für Sie die Unterstützung optional. Hinzugefügt zusätzliche Informationen.
- Könnten Sie näher erläutern, Wann/warum Sie brauchen, um zu verwenden, nullables, um sicherzustellen Werte sind optional? Wenn Sie nicht machen, die Werte nullable (für ex, Eigentum int Skip) und es ist keine Abfrage Parameter für diese Eigenschaft angegeben ist, wird die API Controller-Methode wird noch immer erfolgreich die Anforderung übereinstimmt und der Wert für Skip nur der default-Wert für diesen Typ, oder in diesem Fall 0
- Ohne eine nullable-Typ, den Sie wissen nicht, wenn der Benutzer nicht geben Sie einen Wert ein und bekam nicht initialisierte Typ Wert (0 für int) oder wenn der angegebene Benutzer 0. Durch verwenden von auf null festlegbaren Sie sicher, dass der Benutzer es Links undefiniert, daher können Sie sicher anwenden Ihre Standard-in die controller-action. Wenn Sie schauen, Nehmen Sie aus dem Beispiel oben, was sollte die Aktion tun, wenn es erhalten 0 für Nehmen? Hat der user meine Anfrage 0 Datensätze ein, oder hat er nicht angeben, und deshalb sollten Sie alle Rekorde. Im Allgemeinen, wenn Sie möchten, eine Wert-Typ (int, bool, etc.) freiwillig zu sein, dann sollte es null sein.
InformationsquelleAutor Andrew C
62

Verwendung der anfänglichen Standardwerte für alle Parameter, wie unten
```
public string GetFindBooks(string author="", string title="", string isbn="", string  somethingelse="", DateTime? date= null) 
{
    //...
}
```
- Dies ist die korrekte Vorgehensweise, sondern für eine Sache: DateTime null ist nicht zulässig. Ich habe bereits versucht zu verwenden DateTime? statt, aber dann MVC nicht die Zuordnung der Anforderung zu der gegebenen Methode, wenn ich nur einige der Parameter in der HTTP-Anfrage.
- übergeben Sie das Datum als string und parse es in Ihrem controller-Funktion mithilfe von DateTime.Parse () - Funktion.
- keine nullable - Datentyp. Sollte Ihr code nicht kompilieren, da du nicht in der Lage zu ordnen eine null Wert zu einem parameter vom Typ DateTime. Vielleicht sollte man es ändern, um DateTime?, oder verwenden Sie verschiedene Wert für einen Standard wie DateTime.Now.
- DateTime.Jetzt ist keine compile-Zeit-Konstante, so kann es nicht zugeordnet werden, da der default-parameter.
- du hast Recht, in der Tat. Datetime.Now kann nicht verwendet werden default-parameter-Initialisierung, ich stehe korrigiert.
InformationsquelleAutor Muhammad Amin
1

möchten Sie mehrere Parameter übergeben, dann können Sie Modell erstellen, anstatt die übergabe mehrerer Parameter.

falls Sie nicht möchten, übergeben Sie einen parameter, so können Sie überspringen, wie gut es ist, und der code wird ordentlich Aussehen und sauber.
- Dies gilt nur für die POST-Parameter in der request-body - params in der url können immer noch Referenz einzeln als Argumente.
InformationsquelleAutor vijay

Default-Werte können nicht geliefert werden für die Parameter nicht deklariert 'optional'

 Function GetFindBooks(id As Integer, ByVal pid As Integer, Optional sort As String = "DESC", Optional limit As Integer = 99)

In Ihrem WebApiConfig

 config.Routes.MapHttpRoute( _
          name:="books", _
          routeTemplate:="api/{controller}/{action}/{id}/{pid}/{sort}/{limit}", _
          defaults:=New With {.id = RouteParameter.Optional, .pid = RouteParameter.Optional, .sort = UrlParameter.Optional, .limit = UrlParameter.Optional} _
      )

Tatsächlich, Sie können. Ich bin mit C#, nicht VB.NET.

InformationsquelleAutor Rizwan Mumtaz

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.