Appendix B. Using Problem Details with Other Formats (他の形式での問題詳細の使用)

いくつかの状況では、ここで説明されている形式以外の形式に問題詳細を埋め込むことが有利な場合があります。例えば、HTML [W3C.REC-html5-20141028] を使用する API は、問題詳細を表現するために HTML も使用したい場合があります。

問題詳細は、既存のシリアル化(JSON または XML)の 1 つをその形式にカプセル化するか、問題詳細のモデル(セクション 3 で指定)をその形式の規約に変換することによって、他の形式に埋め込むことができます。

例えば、HTML では、script タグに JSON をカプセル化することによって問題を埋め込むことができます:

<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>

または RDFa [W3C.REC-rdfa-core-20130822] へのマッピングを発明することによって。

本仕様は、他の形式に問題詳細を埋め込むことに関する特定の推奨事項を行いません。それらを埋め込む適切な方法は、使用されている形式とその形式のアプリケーションの両方に依存します。

謝辞 (Acknowledgements)

著者は、本仕様のレビューに対して Jan Algermissen、Subbu Allamaraju、Mike Amundsen、Roy Fielding、Eran Hammer、Sam Johnston、Mike McCall、Julian Reschke、James Snell に感謝します。

著者の連絡先 (Authors' Addresses)

Mark Nottingham
Akamai

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

Erik Wilde

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