7. 参考文献 (References)
本节列出 HTTP Problem Details 规范使用的规范性和资料性参考文献. 规范性引用定义 ABNF、HTTP 语义、JSON、URI、XML 和 IANA 考虑事项流程; 资料性引用提供 about URI、HTML、RELAX NG、JSON Pointer、JSON Schema、RDFa、早期 Problem Details、tag URI、Web Linking 和 XSLT 等背景.
Problem Details 同时涉及 HTTP 状态、JSON/XML 表示、URI 标识和扩展成员, 因此引用分布在 Web、数据格式和注册流程多个领域. 英文标题、作者、DOI 和 URL 保持原文, 以便实现者查阅原始规范.
7.1. 规范性参考文献 (Normative References)
规范性引用定义 problem object 的语法、媒体类型、URI 处理和注册要求.
[ABNF] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, DOI 10.17487/RFC5234, January 2008, https://www.rfc-editor.org/info/rfc5234.
[HTTP] Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke, Ed., "HTTP Semantics", STD 97, RFC 9110, DOI 10.17487/RFC9110, June 2022, https://www.rfc-editor.org/info/rfc9110.
[JSON] Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", STD 90, RFC 8259, DOI 10.17487/RFC8259, December 2017, https://www.rfc-editor.org/info/rfc8259.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, https://www.rfc-editor.org/info/rfc2119.
[RFC8126] Cotton, M., Leiba, B., and T. Narten, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 8126, DOI 10.17487/RFC8126, June 2017, https://www.rfc-editor.org/info/rfc8126.
[RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, https://www.rfc-editor.org/info/rfc8174.
[URI] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, DOI 10.17487/RFC3986, January 2005, https://www.rfc-editor.org/info/rfc3986.
[XML] Bray, T., Paoli, J., Sperberg-McQueen, C. M., Maler, E., and F. Yergeau, "Extensible Markup Language (XML) 1.0 (Fifth Edition)", W3C Recommendation REC-xml-20081126, November 2008, https://www.w3.org/TR/2008/REC-xml-20081126/.
7.2. 资料性参考文献 (Informative References)
资料性引用帮助理解 Problem Details 与 JSON Schema、Web Linking、HTML 和 RDFa 等生态的关系.
实现 HTTP Problem Details 时, 规范性引用决定对象成员、媒体类型和 URI 处理的基本约束; 资料性引用则帮助解释 problem type URI 如何与 Web 文档、链接关系、schema 描述和可读错误页面结合. 因此, 本节既面向协议实现者, 也面向 API 设计者和文档维护者.
如果实现同时提供 JSON 和 XML 表示, 需要分别参考 JSON、XML、URI 和 HTTP 语义文献, 确保错误对象在不同表示之间保持同一问题类型和同一状态语义. 如果使用 JSON Schema 或 Web Linking 辅助文档化, 则应将其视为描述和发现机制, 而不是替代正文中的规范性要求.
对于 API 设计者, 本节还提示了错误响应文档化的边界: type URI 可以指向人类可读说明, JSON Schema 可以辅助校验对象形状, 但错误类型的长期稳定性、扩展成员命名和 HTTP 状态码选择仍需遵循正文规则.
[ABOUT] Moonesamy, S., Ed., "The "about" URI Scheme", RFC 6694, DOI 10.17487/RFC6694, August 2012, https://www.rfc-editor.org/info/rfc6694.
[HTML5] WHATWG, "HTML: Living Standard", https://html.spec.whatwg.org.
[ISO-19757-2] ISO, "Information technology -- Document Schema Definition Language (DSDL) -- Part 2: Regular-grammar-based validation -- RELAX NG", ISO/IEC 19757-2:2008, December 2008, https://www.iso.org/standard/52348.html.
[JSON-POINTER] Bryan, P., Ed., Zyp, K., and M. Nottingham, Ed., "JavaScript Object Notation (JSON) Pointer", RFC 6901, DOI 10.17487/RFC6901, April 2013, https://www.rfc-editor.org/info/rfc6901.
[JSON-SCHEMA] Wright, A., Ed., Andrews, H., Ed., Hutton, B., Ed., and G. Dennis, "JSON Schema: A Media Type for Describing JSON Documents", Work in Progress, Internet-Draft, draft-bhutton-json-schema-01, 10 June 2022, https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-01.
[RDFA] Adida, B., Birbeck, M., McCarron, S., and I. Herman, "RDFa Core 1.1 - Third Edition", W3C Recommendation, March 2015, https://www.w3.org/TR/2015/REC-rdfa-core-20150317/.
[RFC7807] Nottingham, M. and E. Wilde, "Problem Details for HTTP APIs", RFC 7807, DOI 10.17487/RFC7807, March 2016, https://www.rfc-editor.org/info/rfc7807.
[TAG] Kindberg, T. and S. Hawke, "The 'tag' URI Scheme", RFC 4151, DOI 10.17487/RFC4151, October 2005, https://www.rfc-editor.org/info/rfc4151.
[WEB-LINKING] Nottingham, M., "Web Linking", RFC 8288, DOI 10.17487/RFC8288, October 2017, https://www.rfc-editor.org/info/rfc8288.
[XSLT] Clark, J., Pieters, S., and H. Thompson, "Associating Style Sheets with XML documents 1.0 (Second Edition)", W3C Recommendation, October 2010, https://www.w3.org/TR/2010/REC-xml-stylesheet-20101028/.