Wir entwickeln eine RESTful-API, um Sammlungen von Dokumenten zurückzugeben. Unsere erste Implementierung verwendet HTTP-Statuscodes, um anzugeben, ob eine Anfrage nicht erfüllt werden konnte. Dies scheint eine allgemein akzeptierte Best Practice zu sein (siehe zum Beispiel hier ).
Wir sind kürzlich auf ein Problem gestoßen, bei dem ein Benutzer 1000 Dokumente abgerufen hat. Eines der Dokumentabrufvorgänge ist fehlgeschlagen, und daher haben wir einen HTTP 500-Statuscode zurückgegeben.
Eine Alternative wäre, einen HTTP 200-Statuscode mit der Nutzlast zurückzugeben, die die 999 Dokumente enthält, die wir abrufen konnten, und dann eine Fehlerauflistung, die angibt, welche fehlgeschlagen ist.
Ist dieser alternative Ansatz eine Verletzung der REST-Prinzipien? Wie soll diese Situation gehandhabt werden? Gibt es neben diesen beiden Möglichkeiten noch weitere Möglichkeiten?
Ja, ich denke, es ist vollkommen akzeptabel, solange Sie dokumentieren, dass die Daten, die Sie zurückgeben, eine "Fehler" -Sammlung enthalten können. Dies bedeutet, dass jeder semantische Medientyp, den Sie zur Beschreibung dieser Sammlung von Dokumenten verwenden, über eine Dokumentation verfügen sollte, die beschreibt, wie die Sammlung von Dokumenten aussehen sollte und wie die Fehlersammlung aussehen sollte. Der Client kann dann entscheiden, was mit diesen Informationen geschehen soll.
Wenn Sie dies zum Beispiel als JSON zurückgeben (nur ein Beispiel), haben Sie möglicherweise einen Medientyp wie application/json+documents oder etwas, das wie folgt aussehen könnte:
Sie hätten dann eine Dokumentation, die beschreibt, wie die Dokumente aussehen und wie die Fehler aussehen. In wirklich RESTful-APIs sind die Medientypen dokumentiert und nicht die Aufrufe, da es in einer echten RESTful-API nur einen Endpunkt gibt und alles andere über diesen initialen Endpunkt in Verbindung mit semantischen Medientypen "entdeckt" wird. Solange Sie dokumentieren, dass Fehler möglich sind, und Sie beschreiben das Format, in dem die Fehler geliefert werden, sollten Sie in Ordnung sein.
Dies ist auch keine "außergewöhnliche" Bedingung, da es in Ihrem Fall so aussieht, dass es absehbar ist, dass ein Client möglicherweise nicht alle Dokumente abrufen kann. Daher ist es in Ordnung, den Kunden über diese Tatsache zu informieren.
Tags und Links api rest api-design restful-url