跳至主要内容

API 版本

了解如何在每次向 REST API 发出请求时指定要使用的 REST API 版本。

关于 API 版本控制

GitHub REST API 是版本化的。API 版本名称基于 API 版本发布的日期。例如,API 版本2022-11-28于 2022 年 11 月 28 日(周一)发布。

任何重大更改都将在新的 API 版本中发布。重大更改是指可能破坏集成的更改。重大更改包括:

  • 移除整个操作
  • 移除或重命名参数
  • 移除或重命名响应字段
  • 添加新的必需参数
  • 将以前可选的参数设为必需
  • 更改参数或响应字段的类型
  • 移除枚举值
  • 为现有参数添加新的验证规则
  • 更改身份验证或授权要求

任何附加性(非重大)更改都将在所有受支持的 API 版本中可用。附加性更改是指不应破坏集成的更改。附加性更改包括:

  • 添加操作
  • 添加可选参数
  • 添加可选请求头
  • 添加响应字段
  • 添加响应头
  • 添加枚举值

发布新的 REST API 版本后,之前的 API 版本将在新 API 版本发布后的至少 24 个月内继续受支持。

指定 API 版本

您应该使用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错误。

升级到新的 API 版本

在升级到新的 REST API 版本之前,您应该阅读新 API 版本的重大更改日志,以了解其中包含哪些重大更改,并了解有关如何升级到该特定 API 版本的更多信息。有关更多信息,请参阅“重大更改”。

当您更新集成以在X-GitHub-Api-Version标头中指定新的 API 版本时,您还需要进行任何必要的更改,以使您的集成能够与新的 API 版本一起使用。

更新集成后,请测试您的集成以验证它是否与新的 API 版本一起正常工作。

受支持的 API 版本

当前支持以下 REST API 版本:

2022-11-28

您也可以发出 API 请求以获取所有受支持的 API 版本。有关更多信息,请参阅“REST API 元数据端点”。