跳至主要内容

重大更改

了解每个 REST API 版本中引入的重大更改。

关于 REST API 中的重大更改

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

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

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

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

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

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

有关 API 版本的更多信息,请参阅“API 版本”。

升级到新 API 版本

在升级到新的 REST API 版本之前,您应该阅读此页面上与新 API 版本相对应的部分,以了解包含哪些重大更改,并了解有关如何升级到该 API 版本的更多信息。

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

更新集成后,测试您的集成以验证它是否与新 API 版本一起使用。

2022-11-28 的重大更改

版本 2022-11-28 是引入基于日期的版本控制后的第一个 GitHub REST API 版本。此版本不包含任何重大更改。