Zum Inhalt springen
BeispielWerk
English

API-Fehlerantworten als JSON, OAuth und HTML

Clients müssen mit sehr unterschiedlichen Fehlerantworten zurechtkommen, nicht nur mit sauberem JSON. Die Beispiele zeigen eine Fehlerantwort mit Code und Meldung, eine Liste mehrerer Fehler mit JSON-Pointer-Pfaden, das OAuth-Fehlerformat, eine Antwort mit leerem Body und eine HTML-Fehlerseite eines Proxys mit 502. Damit lässt sich testen, ob ein Client robust auf Fehler reagiert.

5 Varianten auf einer Seite, jede mit eigenem Kopier- oder Download-Knopf.

  • Einfache Fehlerantwort mit Code und Meldung

    {
      "fehler": {
        "code": "RECHNUNG_NICHT_GEFUNDEN", …

    Eigenes Schema ohne RFC.

  • Fehlerantwort mit mehreren Fehlern

    {
      "fehler": [
        { …

    Pfade als JSON Pointer.

  • OAuth-Fehlerantwort

    {
      "error": "invalid_token",
      "error_description": "Das Token ist abgelaufen." …

    Felder error und error_description nach RFC 6749/6750.

  • Fehlerantwort mit leerem Body (nur Status)

    HTTP/1.1 500 Internal Server Error
    Content-Length: 0

    Für Clients, die damit zurechtkommen müssen.

  • HTML-Fehlerseite eines Proxys (502)

    <html>
    <head><title>502 Bad Gateway</title></head>
    <body> …

    Wenn ein JSON-Client HTML erhält, scheitert JSON.parse.

Weitere Themen in Web & API