示例指南类别

介绍段落 – 此指南类别解决什么问题？一段实施者可以理解的散文。此段落应描述指南的意图和范围。标题和此第一段应分别用作提交消息的主题行和正文。

关于使用此模板的一些说明

每个文件应为一组相关的指南，例如“HTTP 标头”或类似内容。每个指南都有自己的子标题，并且每个部分都包含概述/介绍、指导部分、示例和参考。并非每个指南都会填写每个部分。如果某个部分对于特定指南来说确实不必要，您可以删除它。

指南名称

一条正在建议的详细指南。如果适用，它也应该有一个介绍。

指导

API 特别兴趣组希望提供的实际指导。

  • 该指南应清楚地说明实施者需要采取的行动。

  • 应避免引用特定的技术实现（例如，XXX-Y.Z 包）。

  • 外部参考应通过注释在参考部分中描述指向源材料的链接。（例如，请参阅 RFC 0000 或此脚注指南 [1]）

示例

一系列演示所提议指南的正确用法的示例。这些示例可能包括但不限于

  • JSON 对象。

  • 演示请求和响应的 HTTP 方法。

示例不应包括

  • 为实施设计的代码示例。

参考资料

在它们有助于更全面地理解指南的情况下，可以提供参考。您不需要任何参考。此外，即使您的参考不可用，此指南仍然应该有意义。您可以包含的内容示例是

  • 邮件列表或 IRC 讨论的链接

  • 峰会会议记录的链接

  • 如果合适，相关研究的链接

RST 以以下格式支持脚注

脚注