Wie behandeln optionaler query-string-Parameter in die Web-API

Ich Schreibe eine Web-API, und ich bin der Hoffnung, zu erfahren, was der beste Weg zu handhaben optionale query-string-Parameter ist.

Habe ich eine Methode definiert unten:

    [HttpPost]
    public HttpResponseMessage ResetPassword(User user)
    {
        var queryVars = Request.RequestUri.ParseQueryString();
        int createdBy = Convert.ToInt32(queryVars["createdby"]);
        var appId = Convert.ToInt32(queryVars["appid"]);
        var timeoutInMinutes = Convert.ToInt32(queryVars["timeout"]);

        _userService.ResetPassword(user, createdBy, appId, timeoutInMinutes);
        return new HttpResponseMessage(HttpStatusCode.OK);
    }

Ich bin in der Lage, rufen Sie diese durch die Bereitstellung der Benutzer-Objekt in der post-Text und Optional die Bereitstellung der zusätzlichen query-string-Werte, aber ist das Parsen der beste Weg zu gehen, wenn ich ein Einzelfall, der eine zufällige Auswahl der Parameter?

Was ist, wenn ich hatte das gleiche Szenario, aber 15 optionale Parameter (Extremfall vielleicht)?

InformationsquelleAutor earthling | 2013-04-17
  1. 5

    Sollten Sie einen view-Modell enthält alle möglichen Parameter. Und dann haben Sie Ihre API-Methode nehmen Sie das view-Modell als parameter. Und berühren Sie niemals die raw-query-string in Ihre Aktion:

    public class UserViewModel
{
    public string CreatedBy { get; set; }
    public string AppId { get; set; }
    public int? TimeoutInMinutes { get; set; }

    ... other possible parameters
}

    und dann in Ihrer Aktion konnten Sie map view-Modell auf die Domäne Modell:

    [HttpPost]
public HttpResponseMessage ResetPassword(UserViewModel userModel)
{
    User user = Mapper.Map<UserViewModel, User>(userViewModel);
    _userService.ResetPassword(user, userModel.CreatedBy, userModel.AppId, userModel.TimeoutInMinutes);
    return new HttpResponseMessage(HttpStatusCode.OK);
}
    • wirklich, auch für web-api? Cool, ich werde probieren
    • Ja, view-Modelle sind die Antwort auf alle Probleme. Sie sind wie die Zahl 42.
    • Hat die API-Dokumentation helfen, die Sachen funktionieren in diesem Fall aber? Ich habe festgestellt, dass nur primitive params Arbeit mit der generierten Hilfe docs.
    • was ist das routing gehen zu müssen, zu schauen, wie das funktioniert?
    • die Standard-route wird gut funktionieren.
    • so könnte das oben geändert werden, um zu arbeiten mit einem HTTP-Get?
    • natürlich.
    • wie würde das query-string Aussehen? wäre das korrekt? /ResetPassword?userModel.CreatedBy=somevalue&userModel.AppId=someValue&...etc?
    • Sie nicht brauchen, um das Präfix mit userModel. Folgendes sollte auch funktionieren: /ResetPassword?createdBy=somevalue&appId=someValue&....
    • Ich glaube, Sie haben zu verwenden [FromUri] vor der viewmodel-parameter. Ie: ([FromUri] UserViewModel userModel)

    InformationsquelleAutor Darin Dimitrov
  2. 2

    Würden Sie ein ViewModel, das ist im Grunde eine Sammlung aller von den übergebenen Parametern zwischen client und server gekapselt in einem einzigen Objekt. (Dies ist die VM in MVVM)

    InformationsquelleAutor paul
Schreibe einen Kommentar