Zum Hauptinhalt springen

Appendix B. Using Problem Details with Other Formats (Verwendung von Problemdetails mit anderen Formaten)

In einigen Situationen kann es vorteilhaft sein, Problemdetails in anderen als den hier beschriebenen Formaten einzubetten. Beispielsweise könnte eine API, die HTML [W3C.REC-html5-20141028] verwendet, auch HTML für die Darstellung ihrer Problemdetails verwenden wollen.

Problemdetails können in andere Formate eingebettet werden, entweder durch Kapselung einer der vorhandenen Serialisierungen (JSON oder XML) in dieses Format oder durch Übersetzung des Modells eines Problemdetails (wie in Abschnitt 3 spezifiziert) in die Konventionen des Formats.

Zum Beispiel könnte in HTML ein Problem durch Kapselung von JSON in ein Script-Tag eingebettet werden:

<script type="application/problem+json">
  {
   "type": "https://example.com/probs/out-of-credit",
   "title": "You do not have enough credit.",
   "detail": "Your current balance is 30, but that costs 50.",
   "instance": "/account/12345/msgs/abc",
   "balance": 30,
   "accounts": ["/account/12345",
                "/account/67890"]
  }
</script>

oder durch Erfindung einer Zuordnung zu RDFa [W3C.REC-rdfa-core-20130822].

Diese Spezifikation macht keine spezifischen Empfehlungen bezüglich der Einbettung von Problemdetails in andere Formate; die geeignete Art und Weise, sie einzubetten, hängt sowohl von dem verwendeten Format als auch von der Anwendung dieses Formats ab.

Danksagungen (Acknowledgements)​

Die Autoren möchten Jan Algermissen, Subbu Allamaraju, Mike Amundsen, Roy Fielding, Eran Hammer, Sam Johnston, Mike McCall, Julian Reschke und James Snell für die Überprüfung dieser Spezifikation danken.

Adressen der Autoren (Authors' Addresses)​

Mark Nottingham
Akamai

Email: [email protected]
URI: https://www.mnot.net/

Erik Wilde

Email: [email protected]
URI: http://dret.net/netdret/

Letztes Update am