Welcher MIME-Typ, wenn JSON von einer REST-API zurückgegeben wird?

Question

Meine REST-API gibt JSON zurück.

Ich gebe gerade Text/Ebene als MIME-Typ zurück, aber es fühlt sich lustig an. Sollte ich application/x-javascript oder einen anderen Typ zurückgeben?

Die zweite Frage bezieht sich auf den HTTP-Statuscode für Fehlerbedingungen. Wenn mein REST API einen Fehlerzustand zurückkehrt, ich als JSON zurückkehre

{ result: "fail", errorcode: 1024, errormesg: "That sucked. Try again!" } 

Sollte der HTTP-Statuscode bleiben bei 200 OK?

Answer 1

Die JSON Spezifikation schlägt application/json vor, und das scheint von der IETF und IANA Registrierung unterstützt werden.

Bei der zweiten Frage, denke ich, wenn die Behandlung von Nachrichten in irgendeiner Weise fehlschlägt, sollten Sie eine strukturierte und Standardfehlerantwort als JSON-Nachricht zurückgeben; Nur wenn die Nachricht aus irgendeinem Grund nicht an den Back-End-Handler gesendet wird, sollten Sie einen HTTP-Fehlercode in Betracht ziehen.

-Update 2014.06.27: Die Tage, an denen Kunden (Browser) nur mit einer 200-Antwort sind längst vorbei und die vorherrschende Beratung ist für RESTful APIs gearbeitet, um HTTP-Response-Codes geeignet für die Reaktion zu verwenden, 2xx für erfolgreiche Antworten (z. B. 201 für PUT erstellt; 204 kein Inhalt für DELETE) und 4xx und 5xx für alle Fehlerbedingungen, einschließlich derjenigen aus der API selbst.

Answer 2

Ich bevorzuge es, sowohl mit einem HTTP-Fehlerstatus als auch mit anwendungsspezifischen Nutzdaten zu antworten.

Answer 3

Der MIME-Typ von JSON ist

application/json

http://www.ietf.org/rfc/rfc4627.txt

http://www.iana.org/assignments/media-types/application/

Insbesondere hier:

http://www.ietf.org/rfc/rfc4627.txt

Answer 4

Nein, Sie sollten 200 in einem Fehlerzustand nicht zurückgeben.

Es ist in Ordnung, den Statuscode zu wiederholen oder einen detaillierteren Fehlercode in die Antwortnutzlast einzufügen.

Answer 5

Die richtige Content-type zurückgeben ist application/json, nach RFC 4627, die auch den MIME-Typ IANA registriert (und tatsächlich, es zeigt sich auf IANA-Seite). Natürlich, wenn Sie einen Kunden schreiben, möchten Sie liberaler sein, was Sie akzeptieren, und auch andere wie text/json und text/x-json akzeptieren.

Jetzt, wenn es einen Fehler gibt, sollten Sie nicht HTTP 200 zurückgeben, das ist grundsätzlich nicht RESTful. Ich weiß, dass es manchmal keine exakte Übereinstimmung für Ihren Fehler gibt, aber wählen Sie die nächsten Fehler 4XX (Fehler des Clients) oder 5XX (Fehler des Servers) in RFC 2616 Sections 10.4 -10.5 und genauer im JSON.

Answer 6

Wenn Sie mit "REST-API" meinen, dass Sie einer REST-Architektur folgen möchten, wird der zu verwendende Medientyp von der Funktionalität bestimmt, die Sie über die REST-API bereitstellen möchten. Möchten Sie neue Objekte erstellen können? Abfrage einer Liste von Objekten? Ein Objekt bearbeiten? Wenn dies der Fall ist, könnte ein guter zu verwendender RESTful-Medientyp vnd.collection + json sein, weil er eine hypertextverknüpfte Schnittstelle definiert, um eine Sammlung von json-Objekten zu manipulieren.

Hinweis: Eine RESTful-API könnte den Medientyp application/json verwenden, aber dieser Medientyp hat keine Hypertext-verknüpfte RESTful-Schnittstelle, daher wäre es ein Endpunkt der Statusänderung. Es ist auch völlig akzeptabel, einer Web-API-Architektur zu folgen, in der HTTP-RPC-Aufrufe Anwendungs-/JSON-Objekte zurückgeben und andere HTTP-RPC-Aufrufe diese Objekte manipulieren und es keine Hypertext-Link-Schnittstelle für die Verwendung und Navigation der Statusänderungen gibt. Aber das ist nicht REST.

Ich mag diese Beschreibung von REST (vom Schöpfer des REST):

REST APIS must be hypertext driven

Mit anderen Worten, wenn der Motor des Anwendungszustand (und damit die API) nicht angetrieben wird per Hypertext, dann kann es nicht RESTful sein und kann nicht eine REST API sein. Zeitraum.

Auch aus der Diskussion dieser Beitrag ist dieses Beispiel für eine RESTful Anwendung: Lost Boys's Spam-E REST Application