RFC 9457 - HTTP API 问题详情

互联网工程任务组 (IETF)
Request for Comments: 9457
废弃: RFC 7807
类别: 标准轨道

作者:

• M. Nottingham
• E. Wilde
• S. Dalal

日期: 2023年7月

---

摘要

本文档定义了一种"问题详情" (problem detail) 格式, 用于在 HTTP 响应内容中传递机器可读的错误详情, 以避免为 HTTP API 定义新的错误响应格式的需要。

本文档废弃 RFC 7807。

---

本备忘录的状态

这是一份互联网标准轨道文档。

本文档是互联网工程任务组 (IETF) 的产品。它代表了 IETF 社区的共识。它已经接受了公开审查, 并已获得互联网工程指导组 (IESG) 的批准发布。有关互联网标准的更多信息可在 RFC 7841 的第 2 节中找到。

有关本文档当前状态、勘误表以及如何提供反馈的信息可从 https://www.rfc-editor.org/info/rfc9457 获取。

---

版权声明

Copyright (c) 2023 IETF Trust 及文档作者标识的人员。保留所有权利。

本文档受 BCP 78 和 IETF Trust 关于 IETF 文档的法律规定 (https://trustee.ietf.org/license-info) 的约束, 这些规定在本文档发布之日有效。请仔细阅读这些文档, 因为它们描述了您对本文档的权利和限制。从本文档中提取的代码组件必须包含 Trust Legal Provisions 第 4.e 节中描述的修订版 BSD 许可证文本, 并按照修订版 BSD 许可证中的描述提供, 不提供任何担保。

---

目录

• 1. Introduction (简介)
• 2. Requirements Language (要求语言)
• 3. The Problem Details JSON Object (问题详情 JSON 对象)
  • 3.1 Members of a Problem Details Object (问题详情对象的成员)
    • 3.1.1 "type"
    • 3.1.2 "status"
    • 3.1.3 "title"
    • 3.1.4 "detail"
    • 3.1.5 "instance"
  • 3.2 Extension Members (扩展成员)
• 4. Defining New Problem Types (定义新的问题类型)
  • 4.1 Example (示例)
  • 4.2 Registered Problem Types (已注册的问题类型)
    • 4.2.1 about:blank
• 5. Security Considerations (安全考虑)
• 6. IANA Considerations (IANA 考虑)
• 7. References (参考文献)
  • 7.1 Normative References (规范性参考文献)
  • 7.2 Informative References (信息性参考文献)
• Appendix A. JSON Schema for HTTP Problems (HTTP 问题的 JSON Schema)
• Appendix B. HTTP Problems and XML (HTTP 问题与 XML)
• Appendix C. Using Problem Details with Other Formats (在其他格式中使用问题详情)
• Appendix D. Changes from RFC 7807 (与 RFC 7807 的变更)
• Acknowledgements (致谢)
• Authors' Addresses (作者地址)

---

相关资源

• 官方 RFC: RFC 9457 (TXT)
• DataTracker: RFC 9457
• 废弃: RFC 7807