关于 API 版本控制
GitHub REST API 采用版本化管理。API 版本名称基于该版本发布的日期。例如，API 版本 2026-03-10 于 2026 年 3 月 10 日（星期二）发布。
破坏性更改是指可能导致集成失效的更改。我们将在发布破坏性更改前提供提前通知。破坏性更改包括：
- 删除整个操作
- 删除或重命名参数
- 删除或重命名响应字段
- 添加新的必需参数
- 将之前可选的参数设为必需
- 更改参数或响应字段的类型
- 删除枚举值
- 为现有参数添加新的验证规则
- 更改身份验证或授权要求
任何增量（非破坏性）更改都将在所有受支持的 API 版本中可用。增量更改是指不应导致集成失效的更改。增量更改包括：
- 添加操作
- 添加可选参数
- 添加可选请求头
- 添加响应字段
- 添加响应头
- 添加枚举值
当发布新 REST API 版本时，之前的 API 版本将在新版本发布后至少再被支持 24 个月。
指定 API 版本
您应该使用 X-GitHub-Api-Version 请求头来指定 API 版本。例如：
curl --header "X-GitHub-Api-Version:2026-03-10" https://api.github.com/zen
未携带 X-GitHub-Api-Version 请求头的请求将默认使用 2022-11-28 版本。
如果您指定了已不再受支持的 API 版本，则会收到 400 错误。
升级到新的 API 版本
在升级到新的 REST API 版本之前，您应阅读该新版本的破坏性更改日志，了解其中包含的破坏性更改以及如何升级到该特定 API 版本。更多信息，请参见 破坏性更改。
当您在 X-GitHub-Api-Version 请求头中指定新 API 版本后，还需进行相应的修改，使您的集成能够在新 API 版本下正常工作。
更新集成后，请对其进行测试，以验证其在新 API 版本下是否能够正常运行。
受支持的 API 版本
以下 REST API 版本目前受支持：
2026-03-10
2022-11-28
您也可以发起 API 请求以获取所有受支持的 API 版本。更多信息，请参见 元数据的 REST API 端点。