Ist es per REST in Ordnung, Inhalte nach dem POST zurückzugeben?

Ich verwende RESTlet und habe eine Ressource erstellt. Ich behandle POST durch Überschreiben der acceptRepresentationMethode.

Der Client sollte mir einige Daten senden, dann speichere ich sie in der Datenbank, setze die Antwort auf 201 (SUCCESS_CREATED) und muss einige Daten an den Client zurückgeben, aber der Rückgabetyp acceptRepresentationist void.

In meinem Fall muss ich einen Bezeichner zurückgeben, damit der Client auf diese Ressource zugreifen kann.

Wenn ich beispielsweise eine Ressource mit URL hatte /resourceund der Client eine POST-Anfrage sendet, füge ich eine neue Zeile in die Datenbank ein und deren Adresse sollte lauten /resource/{id}. Ich muss senden {id}.

Mache ich etwas falsch? Können nach den REST-Prinzipien nach dem POST etwas zurückgegeben werden? Wenn ja, wie kann ich das machen und wenn nein, wie gehe ich mit dieser Situation um?

REST sagt nur, dass Sie sich an die einheitliche Schnittstelle anpassen sollten. Mit anderen Worten, es heißt, Sie sollten das tun, was POST gemäß der HTTP-Spezifikation tun soll . Hier ist das Zitat aus dieser Spezifikation, das relevant ist:

Wenn eine Ressource auf dem Ursprungsserver erstellt wurde, MUSS die Antwort 201 (Erstellt) sein und eine Entität enthalten, die den Status der Anforderung beschreibt und auf die neue Ressource verweist, sowie einen Standortheader (siehe Abschnitt 14.30).

Wie Sie sehen können, haben Sie zwei Stellen, an denen Sie dem Client angeben können, wo sich die neu erstellte Ressource befindet. Der Standortheader sollte eine URL enthalten, die auf die neue Ressource verweist, und Sie können auch eine Entität mit den Details zurückgeben.

Ich bin nicht sicher, was der Unterschied zwischen dem Überschreiben von acceptRepresentation () und dem Überschreiben von post () ist, aber dieses Beispiel zeigt, wie eine Antwort von einem POST zurückgegeben wird.

Ich würde darauf verzichten, irgendetwas im Text der Antwort zu senden. Setzen Sie einfach Location: auf die (vollständige) URL der neu erstellten Ressource.

Ihre Beschreibung legt nahe, dass dies genau die Semantik ist, die Sie:

1. POST eine Sache, um es zu erstellen
2. Antworten Sie mit genug, um zwei Dinge zu wissen:
   1. Dass die Schöpfung geschah (die 201)
   2. Wo finde ich das Neue? (Location Header)

Alles andere ist überflüssig.

Zwei verschiedene Fragen:

Unterstützt das REST-Anwendungsmuster die Rückgabe von Daten in einem POST?

Ich glaube nicht, dass REST dies ausdrücklich verbietet, aber die bevorzugte Behandlung ist in Darrels Antwort dargelegt.

Ermöglicht das RESTlet-Framework die Rückgabe von Daten in einem POST?

Ja, obwohl es void zurückgibt, haben Sie in einer Klasse, die Resource erweitert, über die Methode getResponse () vollen Zugriff auf das Objekt Object Response. Sie können also getResponse (). SetEntity () mit beliebigen Daten aufrufen.

Geben Sie es in dem gewünschten Format aus. Das könnte sein:

<success>
    <id>5483</id>
</success>

Oder:

{ "type": "success", "id": 5483 }

Es hängt davon ab, was Sie normalerweise tun. Wenn sie die Daten nicht erwarten, sollten sie sie einfach ignorieren, aber jeder Client, der sie richtig verarbeiten möchte, sollte dies können.

Wenn Sie antworten 201 Erstellt mit einem Entitätskörper anstelle einer Standortumleitung, ist es eine gute Idee, einen Content-Location-Header einzufügen, der auf die Ressource verweist, die in der Antwort dargestellt wird.

Dies vermeidet mögliche Verwirrung - bei der ein Client (zu Recht) annehmen könnte, dass die Antwortentität tatsächlich einen neuen Status des "Erstellers" und nicht der erstellten Ressource darstellt.

> POST /collection
> ..new item..

< 201 Created
< Location: /collection/1354
< Content-Location: /collection/1354
< <div class="item">This is the new item that was created</div>