RFC 9457 - Problemdetails für HTTP-APIs

Internet Engineering Task Force (IETF)
Request for Comments: 9457
Ersetzt: RFC 7807
Kategorie: Standards Track

Autoren:

• M. Nottingham
• E. Wilde
• S. Dalal

Datum: Juli 2023

---

Zusammenfassung

Dieses Dokument definiert ein "Problemdetail" (problem detail), um maschinenlesbare Details von Fehlern im HTTP-Antwortinhalt zu übertragen und somit die Notwendigkeit zu vermeiden, neue Fehlerantwortformate für HTTP-APIs zu definieren.

Dieses Dokument ersetzt RFC 7807.

---

Status dieses Dokuments

Dies ist ein Internet Standards Track-Dokument.

Dieses Dokument ist ein Produkt der Internet Engineering Task Force (IETF). Es repräsentiert den Konsens der IETF-Community. Es hat eine öffentliche Überprüfung erhalten und wurde von der Internet Engineering Steering Group (IESG) zur Veröffentlichung genehmigt. Weitere Informationen zu Internet-Standards sind in Abschnitt 2 von RFC 7841 verfügbar.

Informationen über den aktuellen Status dieses Dokuments, Errata und wie Feedback bereitgestellt werden kann, sind unter https://www.rfc-editor.org/info/rfc9457 erhältlich.

---

Copyright-Hinweis

Copyright (c) 2023 IETF Trust und die als Dokumentautoren identifizierten Personen. Alle Rechte vorbehalten.

Dieses Dokument unterliegt BCP 78 und den rechtlichen Bestimmungen des IETF Trust in Bezug auf IETF-Dokumente (https://trustee.ietf.org/license-info), die zum Zeitpunkt der Veröffentlichung dieses Dokuments gültig sind. Bitte lesen Sie diese Dokumente sorgfältig durch, da sie Ihre Rechte und Einschränkungen in Bezug auf dieses Dokument beschreiben. Code-Komponenten, die aus diesem Dokument extrahiert werden, müssen den Text der überarbeiteten BSD-Lizenz enthalten, wie in Abschnitt 4.e der Trust Legal Provisions beschrieben, und werden ohne Gewährleistung bereitgestellt, wie in der überarbeiteten BSD-Lizenz beschrieben.

---

Inhaltsverzeichnis

• 1. Introduction (Einführung)
• 2. Requirements Language (Anforderungssprache)
• 3. The Problem Details JSON Object (Das Problemdetails-JSON-Objekt)
  • 3.1 Members of a Problem Details Object (Mitglieder eines Problemdetails-Objekts)
    • 3.1.1 "type"
    • 3.1.2 "status"
    • 3.1.3 "title"
    • 3.1.4 "detail"
    • 3.1.5 "instance"
  • 3.2 Extension Members (Erweiterungsmitglieder)
• 4. Defining New Problem Types (Definition neuer Problemtypen)
  • 4.1 Example (Beispiel)
  • 4.2 Registered Problem Types (Registrierte Problemtypen)
    • 4.2.1 about:blank
• 5. Security Considerations (Sicherheitsüberlegungen)
• 6. IANA Considerations (IANA-Überlegungen)
• 7. References (Referenzen)
  • 7.1 Normative References (Normative Referenzen)
  • 7.2 Informative References (Informative Referenzen)
• Appendix A. JSON Schema for HTTP Problems (JSON-Schema für HTTP-Probleme)
• Appendix B. HTTP Problems and XML (HTTP-Probleme und XML)
• Appendix C. Using Problem Details with Other Formats (Verwendung von Problemdetails mit anderen Formaten)
• Appendix D. Changes from RFC 7807 (Änderungen gegenüber RFC 7807)
• Acknowledgements (Danksagungen)
• Authors' Addresses (Adressen der Autoren)

---

Verwandte Ressourcen

• Offizielle RFC: RFC 9457 (TXT)
• DataTracker: RFC 9457
• Ersetzt: RFC 7807