Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2026-04-23. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

重大更改

了解每个 REST API 版本中引入的中断性变更。

关于 REST API 中的中断性变更

GitHub REST API 已版本化。 API 版本名称基于 API 版本的发布日期。 例如,API 版本2026-03-10已于Tue, 10 Mar 2026发布。

破坏性变更是可能会影响集成的变更。 重大更改将在新的 API 版本中发布。 在发布重大更改之前,我们会提前通知。 重大变更包括:

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

所有支持的 API 版本都将包含所有增量(不影响现有功能的)更改。 增量更改是不应破坏集成的更改。 附加更改包括:

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

当发布新版本的 REST API 时,先前的 API 版本将在新版本发布后至少再支持24个月。

有关 API 版本的详细信息,请参阅 API 版本

升级到新的 API 版本

在升级到新 REST API 版本之前,应阅读本页上对应于新 API 版本的部分,以了解包含哪些中断性变更,并详细了解如何升级到该 API 版本。

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

更新集成后,测试集成以验证它是否适用于新 API 版本。

重大变更日志