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

In einigen Situationen kann es vorteilhaft sein, Problem Details in andere Formate als die hier definierten einzubetten. Beispielsweise könnte eine API, die HTML [HTML5] verwendet, auch Problem Details in ihre Antworten einbetten wollen.

API-Designer, die diesen Anwendungsfall erfüllen, werden ermutigt, Konsistenz zu gewährleisten. Beispielsweise kann dies durch die Verwendung der Problemformate durch einfaches Transformieren des Inhalts des Problem-JSON/XML-Dokuments über XSLT [XSLT] und Einbeziehen in das Antwortdokument als Microdata [HTML5] oder RDFa [RDFA] erreicht werden.

Beispielsweise könnte ein Dienst, der die Problem Details in einem HTML-Dokument beschreibt, die Daten unter Verwendung von Microdata so darstellen:

<div itemscope itemtype="urn:ietf:rfc:9457">
  <p>
    Type: <span itemprop="type">https://example.com/probs/out-of-credit</span>
  </p>
  <p>
    Title: <span itemprop="title">You do not have enough credit.</span>
  </p>
  <p>
    Detail: <span itemprop="detail">Your current balance is 30, but that costs 50.</span>
  </p>
  <p>
    Instance: <span itemprop="instance">/account/12345/msgs/abc</span>
  </p>
  <p>
    Balance: <span itemprop="balance">30</span>
  </p>
  <p>
    Accounts:
  </p>
  <ul>
    <li itemprop="accounts">/account/12345</li>
    <li itemprop="accounts">/account/67890</li>
  </ul>
</div>

oder unter Verwendung von RDFa:

<div vocab="urn:ietf:rfc:9457" typeof="">
  <p>
    Type: <span property="type">https://example.com/probs/out-of-credit</span>
  </p>
  <p>
    Title: <span property="title">You do not have enough credit.</span>
  </p>
  <p>
    Detail: <span property="detail">Your current balance is 30, but that costs 50.</span>
  </p>
  <p>
    Instance: <span property="instance">/account/12345/msgs/abc</span>
  </p>
  <p>
    Balance: <span property="balance">30</span>
  </p>
  <p>
    Accounts:
  </p>
  <ul>
    <li property="accounts">/account/12345</li>
    <li property="accounts">/account/67890</li>
  </ul>
</div>

Beachten Sie, dass diese Beispiele nicht als normativ gedacht sind; sie werden nur zur Veranschaulichung bereitgestellt.