如何记录 HTTP 标头

HTTP 标头参考文档记录了超文本传输协议(HTTP)请求和响应消息的标头部分。本文介绍如何为 HTTP 标头创建新的参考页面。

步骤 1 – 确定要记录的 HTTP 标头

步骤 2 – 检查现有的 HTTP 标头页面

  • 现有的 HTTP 标头已在HTTP 参考中进行了记录。
  • 标头有不同的类别:请求标头响应标头表示标头
  • 找出您即将记录的标头的类别(请注意,某些标头可以同时是请求标头和响应标头,具体取决于上下文)。
  • 转到具有相同类别的现有标头参考页面。

步骤 3 – 创建 HTTP 标头页面

步骤 4 – 编写内容

  • 您可以从我们的模板 HTTP 标头页面开始,或者使用您在步骤 2 中找到的现有 HTTP 标头文档之一的复制结构。这取决于您。
  • 编写新的 HTTP 标头文档。
  • 确保您包含以下部分:
    • 导语,其中第一句话应包含标头名称(加粗)并概述其用途。
    • 信息框,至少包含标头类型以及该标头是否为禁止的请求标头
    • 语法框,包含 HTTP 标头所有可能的指令/参数/值。
    • 一个解释这些指令/值的章节。
    • 一个示例章节,其中包含该标头的实际用例,或展示它通常在何处以及如何出现。
    • 一个列出相关 RFC 标准文档的规范章节。
    • 一个列出相关资源的“另请参阅”章节。

步骤 5 – 添加浏览器兼容性信息

  • 如果您查看了其他 HTTP 标头页面,您会发现有一个 `{{Compat}}` 宏,它可以为您填充浏览器兼容性表格。
  • 兼容性表格页面是从结构化数据生成的。如果您想为数据做出贡献,请查看 https://github.com/mdn/browser-compat-data/blob/main/README.md 上的说明,并发送一个 pull request 给我们。

步骤 6 – 更新 HTTP 标头列表

确保您的标头已列在HTTP 标头参考总览页面的相应类别下。

步骤 7 – 获取内容审核

创建标头页面后,提交一个 pull request。我们的审核团队的一名成员将被自动分配来审核您的页面。