如何记录 HTTP 头
MDN Web Docs 上的HTTP 头参考记录了 HTTP 头字段。这些是超文本传输协议 (HTTP) 请求和响应消息报头部分的组成部分。它们定义了 HTTP 事务的操作参数。本文介绍了如何为 HTTP 头创建一个新的参考页面。
你需要了解或能够深入了解一些HTTP。
步骤 1 - 确定要记录的 HTTP 头
- 各种 IETF 标准中定义了许多 HTTP 头。
- IANA 维护着HTTP 头字段注册表,维基百科列出了已知的头字段,但并非所有这些都与 Web 开发人员相关或属于官方标准。
- 如果当前的HTTP 头参考概述页面上存在任何**红色链接**,则这些头是记录的好选择。
- 如有疑问,请咨询 MDN Web Docs 团队,了解记录你选择的头是否有意义。
步骤 2 - 检查现有的 HTTP 头页面
步骤 3 - 创建 HTTP 头页面
- 所有头页面都位于此树下:/docs/Web/HTTP/Headers/
- 要创建新页面,请参阅我们如何创建页面指南中的说明。
步骤 4 - 编写内容
- 可以从我们的模板 HTTP 头页面开始,也可以使用从步骤 2 中找到的现有 HTTP 头文档之一复制的结构。由你选择。
- 编写关于新的 HTTP 头的信息。
- 确保包含以下部分
- 介绍性文本,其中第一句话提到头名称(加粗)并总结其用途。
- 信息框,至少包含头类型以及头是否为禁止的头名称。
- 语法框,包含 HTTP 头的所有可能的指令/参数/值。
- 解释这些指令/值的部分。
- 示例部分,包含此头的实际用例或显示其通常出现的位置和方式。
- 规范部分,列出相关的 RFC 标准文档。
- "另请参阅"部分,列出相关资源。
步骤 5 - 添加浏览器兼容性信息
- 如果你查看过其他 HTTP 头页面,你会看到有一个
{{Compat}}
宏会为你填充浏览器表格。 - 兼容性表格页面是从结构化数据生成的。如果你想参与数据贡献,请查看https://github.com/mdn/browser-compat-data/blob/main/README.md中的说明,并向我们发送拉取请求。
步骤 6 - 更新 HTTP 头列表
确保你的头在HTTP 头参考概述页面上的适当类别中列出。
步骤 7 - 获取内容审核
创建头页面后,将其作为拉取请求提交。我们的审查团队成员将自动分配以审查你的页面。