GitHub REST API 已进行版本控制。API 版本名称基于 API 版本发布日期。例如，API 版本 2022-11-28 于 2022 年 11 月 28 日星期一发布。
任何重大更改都将在新 API 版本中发布。重大更改是指可能破坏集成的更改。重大更改包括
- 删除整个操作
- 删除或重命名参数
- 删除或重命名响应字段
- 添加新的必需参数
- 使以前可选的参数变为必需
- 更改参数或响应字段的类型
- 删除枚举值
- 向现有参数添加新的验证规则
- 更改身份验证或授权要求
任何累加（非重大）更改都将在所有受支持的 API 版本中提供。累加更改是指不应破坏集成的更改。累加更改包括
- 添加操作
- 添加可选参数
- 添加可选请求标头
- 添加响应字段
- 添加响应标头
- 添加枚举值
发布新的 REST API 版本后，之前的 API 版本将在新 API 版本发布后至少再支持 24 个月。
应使用 X-GitHub-Api-Version 标头指定 API 版本。例如
curl --header "X-GitHub-Api-Version:2022-11-28" https://api.github.com/zen
不带 X-GitHub-Api-Version 标头的请求将默认使用 2022-11-28 版本。
如果指定不再受支持的 API 版本，则会收到 400 错误。
在升级到新的 REST API 版本之前，应阅读新 API 版本的重大更改变更日志，以了解包含哪些重大更改，并详细了解如何升级到该特定 API 版本。有关详细信息，请参阅“重大更改”。
在更新集成以在 X-GitHub-Api-Version 标头中指定新 API 版本时，还需要对集成进行任何必要的更改，以使其与新 API 版本配合使用。
更新集成后，请测试集成以验证它是否可与新 API 版本配合使用。
当前支持以下 REST API 版本
2022-11-28
您还可以发出 API 请求以获取所有受支持的 API 版本。有关更多信息，请参阅“元数据的 REST API 端点”。