Skip to main content

Appendix C. Using Problem Details with Other Formats (在其他格式中使用问题详情)

在某些情况下, 将问题详情嵌入到此处描述的格式以外的格式中可能是有利的。例如, 使用 HTML [HTML5] 的 API 可能也想使用 HTML 来表达其问题详情。

问题详情可以通过将现有序列化之一 (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] 的映射。

本规范不对在其他格式中嵌入问题详情提出具体建议; 嵌入它们的适当方式取决于所使用的格式和该格式的应用。