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

場合によっては, ここで説明されている形式以外の形式に問題詳細を埋め込むことが有利な場合があります。例えば, HTML [HTML5] を使用する API は, 問題詳細を表現するために HTML も使用したい場合があります。

問題詳細は, 既存のシリアライゼーションの 1 つ (JSON または XML) をその形式にカプセル化するか, 問題詳細のモデル (セクション 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) [RDFA] へのマッピングを定義することによって。

この仕様は, 他の形式に問題詳細を埋め込むことに関する具体的な推奨事項を示しません。それらを埋め込む適切な方法は, 使用されている形式とその形式の適用の両方に依存します。