Bestes Format zum Senden von Fehlerantworten in einer einfachen API

Question

Ich schreibe eine einfache url-basierte API, die Daten abruft und sendet es zurück in einem von ein paar Formaten (XML, JSON, CSV). Ich bin irgendwie auf dem Zaun über wie man Fehler Antworten behandeln. Wenn der Benutzer ein Format liefert, dann kann ich nur die Antwort in diesem Format senden, aber was über Fälle, in denen der Benutzer ein nicht unterstütztes Format anfordert?

Ist es dann besser, einfach eine willkürlich auszuwählen und diese zu verwenden? Sollte ich etwas wie das Senden von HTTP-Antworten a la REST-APIs statt, so dass es ein wenig mehr Format agnostic ist?

Answer 1

Wenn Sie eine API erstellen, scheint die Verwendung von REST sehr sinnvoll zu sein. Sie haben die Wahl zwischen verschiedenen Formaten, aber dokumentieren Sie den Standard, was auch immer das sein mag, und geben Sie die Fehlermeldung in diesem Format zurück, zusammen mit dem richtigen Antwortcode, der den allgemeinen Grund für den Fehler angibt.

Hier ist ein wenig über Fehlerbehandlung in REST, wenn Sie diese Runde gehen.

http://www.oreillynet.com/onlamp/blog/2003/12/restful_error_handling.html

Answer 2

Wenn ein Client ein nicht unterstütztes Format wünscht, können Sie mit einer 406 Not Acceptable