Zum Inhalt springen
BeispielWerk
English

Problem Details (RFC 9457) als problem+json

Problem Details nach RFC 9457 ist ein Standardformat für Fehler in HTTP-Schnittstellen mit den Feldern type, title, status, detail und instance; der Content-Type lautet application/problem+json. Die Seite enthält Beispiele für die Statuscodes 401, 403, 404, 409, 422, 429 und 500 sowie die Minimalform mit type about:blank. Die type-URLs liegen auf der reservierten Domain example.com.

9 Varianten auf einer Seite, jede mit eigenem Kopier- oder Download-Knopf. Darunter: 7× Reservierter Bereich.

  • Fehlerantwort 401 als problem+json (RFC 9457)Reservierter Bereich

    {
      "type": "https://example.com/probleme/nicht-angemeldet",
      "title": "Nicht angemeldet", …

    Felder type, title, status, detail, instance nach RFC 9457; Content-Type application/problem+json.

  • Fehlerantwort 403 als problem+jsonReservierter Bereich

    {
      "type": "https://example.com/probleme/keine-berechtigung",
      "title": "Keine Berechtigung", …

    Nach RFC 9457.

  • Fehlerantwort 404 als problem+jsonReservierter Bereich

    {
      "type": "https://example.com/probleme/nicht-gefunden",
      "title": "Nicht gefunden", …

    Nach RFC 9457.

  • Fehlerantwort 409 als problem+jsonReservierter Bereich

    {
      "type": "https://example.com/probleme/konflikt",
      "title": "Konflikt", …

    Nach RFC 9457.

  • Fehlerantwort 422 mit Feldfehlern als problem+jsonReservierter Bereich

    {
      "type": "https://example.com/probleme/validierung",
      "title": "Eingabe ungültig", …

    Erweiterungsmitglied „fehler“ mit Feld und Meldung; RFC 9457 erlaubt eigene Felder.

  • Fehlerantwort 429 als problem+jsonReservierter Bereich

    {
      "type": "https://example.com/probleme/zu-viele-anfragen",
      "title": "Zu viele Anfragen", …

    Zusammen mit dem Header Retry-After: 30 senden.

  • Fehlerantwort 500 als problem+jsonReservierter Bereich

    {
      "type": "https://example.com/probleme/interner-fehler",
      "title": "Interner Fehler", …

    Keine internen Details in die Antwort schreiben.

  • problem+json, kleinstmöglich

    {
      "type": "about:blank",
      "title": "Not Found", …

    type about:blank bedeutet: nur der HTTP-Status zählt (RFC 9457).

  • Antwort-Header für problem+json

    HTTP/1.1 404 Not Found
    Content-Type: application/problem+json
    Content-Language: de

    Statuszeile und Header.

Weitere Themen in Web & API