REST: Aktualisierung mehrere Datensätze

Muss ich aktualisieren Sie mehrere Datensätze mit einer einzigen HTTP-Anforderung. Ein Beispiel ist die Auswahl einer Liste von E-Mails und markiert Sie als Ungelesen. Was ist die beste (Restful) Weg, dies zu erreichen?

Den Weg, den ich gerade machst ist, durch die Verwendung eines sub-Ressource-Aktion

PUT http://example.com/api/emails/mark-as-unread

(im Körper)

{ids:[1,2,3....]}

Wenn Sie nicht dieses "update all" Funktion für etwas anderes, das ich denke, dies ist eine gute option, aber wenn Sie es verwenden, dann erstellen Sie eine andere route für die Aktualisierung von ids, das ist, wie ich es tun würde.
Meinst du so etwas wie http://example.com/api/emails/bulk-update und dann übergeben Sie ein array von Objekten?
Ja sowas in der Art, wählen Sie die route, die beschreibt Ihre Funktion am besten

InformationsquelleAutor Tharaka | 2014-02-06

4

Erstellen Sie eine Algorithmus-Endpunkt, wie
```
http://example.com/api/emails/mark-unread
```
bulk-update ist ein Algorithmus, der name, ein Substantiv. Es wird der name des Endpunkts in RUHE, ist die Liste der ids sind Argumente, die auf diesen Algorithmus. In der Regel Menschen senden, die Ihnen als URL-query-Argumente in der POST nennen wie
```
http://example.com/api/emails/mark-unread?ids=1,2,3,4
```
Dies ist sehr sicher, da der POST ist nicht idempotent, und Sie müssen nicht darum kümmern, irgendwelche Nebenwirkungen. Sie könnten anders entscheiden-und wenn Ihre bulk-update trägt die gesamten Zustand von solchen Objekten entscheiden Sie sich für PUT
```
http://example.com/api/emails/bulk-change-state
```
dann würden Sie haben, um den tatsächlichen Zustand in den Körper der http-Aufruf.
Ich würde es vorziehen, eine Reihe von einfachen algo wie mark-unread?ids=1,2,3,4 eher als eine monolithische PUT wie hilft es beim debugging, transparent in logs etc
- Von was ich gelesen habe von anderen über RESTful, das Konzept ist, dass alle URIs repräsentiert Ressourcen (z.B. Substantive), sollte es kein verb in jedem Teil der URI. So, die Einführung der "mark-ungelesen markieren" scheint nicht ganz zu Erholsamen Weg.
- Obwohl es sieht aus wie es ist ein verb, das Sie denken können "mark-ungelesen" als name des Algorithmus, um Verwirrung zu vermeiden
InformationsquelleAutor Igor Katkov
5

Ich diese Seite Lesen - http://restful-api-design.readthedocs.io/en/latest/methods.html#actions - und es schlägt die Verwendung einer "Aktionen" sub-Sammlung. z.B.

POST http://example.com/api/emails/actions

(im Körper)

{"type":"mark-as-unread", "ids":[1,2,3....]}

Zitate aus der referenzierten Webseite:

Manchmal ist es erforderlich, aussetzen, eine operation, die in der API, die inhärent ist nicht Erholsam. Ein Beispiel eines solchen Vorgangs ist, wo Sie vorstellen möchten, einen Zustand zu ändern, für eine Ressource, aber es gibt mehrere Möglichkeiten, in denen der gleiche Endzustand erreicht werden kann, ... Ein gutes Beispiel dafür ist der Unterschied zwischen "ausschalten" und "Herunterfahren" einer virtuellen Maschine.

Als Lösung für solche non-RESTful operations, einer "Aktionen" sub-collection verwendet werden kann, auf eine Ressource. Aktionen sind im Grunde das RPC-Nachrichten an eine Ressource, die zur Ausführung einer bestimmten operation. Die "Aktionen" sub-Sammlung kann gesehen werden als ein Befehl der Warteschlange, um die neue Aktion Gebucht werden können, die dann ausgeführt wird, der von der API. ...

Es sollte angemerkt werden, dass Maßnahmen sollten nur verwendet werden, als eine Ausnahme, wenn es einen guten Grund, der eine operation zugeordnet werden kann, um eine der standard-RESTful-Methoden. ...

InformationsquelleAutor Johnny Wong

Es ein wenig kompliziert zu bekommen Palette von Modellen in einer action-Methode als argument. Der einfachste Ansatz ist die form eines json-Strings vom client und VERÖFFENTLICHEN alle, die auf dem server (auf Ihre Aktion mehtod). Sie können beschließen, die folgenden Ansatz

Sagen Ihre E-Mail-Modell ist wie folgt:

public class Email
{
    public int EmailID {get; set;}
    public int StatusID {get; set;}
    //more properties
}

Also Ihre action-Methode wird in der form:

public bool UpdateAll(string EmailsJson)
{
    Email[] emails = JsonConvert.DeserializeObject<Emails[]>(EmailsJson);
    foreach(Email eml in emails)
    {
        //do update logic
    }
}

Verwenden Json.NET zu helfen, mit der Serialisierung.

Auf dem client kann man den ajax-Aufruf wie folgt:

$.ajax({
    url: 'api/emailsvc/updateall',
    method: 'post',
    data: {
        EmailsJson: JSON.stringify([{
            ID: 1,
            StatusID:2,
            //...more json object properties.
            },
            //more json objects
            ])
        },
    success:function(result){
        if(result)
            alert('updated successfully');
    });

InformationsquelleAutor deostroll

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.

Zitate aus der referenzierten Webseite: