跳转到主要内容

随着 X API v2 的发布,我们推出了全新的版本控制策略,帮助开发者更清楚地了解何时可能对 X 的公开 API 进行变更,以及何时需要迁移到新版本。

我们将通过沟通渠道向开发者通知弃用、下线、变更和新增内容,便于在开发路线图中合理规划以适配这些变化。所有 API 变更都会记录在更新日志中。

目前 X API 提供三个不同版本。除非您所需功能尚未在 v2 中提供,否则我们强烈建议在规划集成时采用 X API v2。

要了解各版本的详细信息,请访问以下页面:

版本管理策略

X API 的版本通过在端点路由路径中声明的版本号来表示:

https://api.x.com/2/tweets

我们将按需发布 X API 的主版本,且发布频率不高于每 12 个月一次。当 API 引入破坏性变更时,将发布主版本。我们会在推出新的主版本时发布迁移指南,帮助开发者迁移至该版本。

破坏性变更要求开发者修改代码,以在其应用中维持既有功能。非破坏性变更为增量更新,将在准备就绪后发布到最新版本;除非希望使用新功能,开发者无需进行任何改动。

如须在版本周期中途推出破坏性变更(出于安全或隐私原因),该变更将应用于最新版本。

重大变更

这些变更要求开发者修改代码,以维持其应用的既有功能。

  • 新增一个必需参数
  • 移除现有端点
  • 移除响应中的任意字段(无论必需或可选)
  • 移除查询参数
  • 重构输入或输出格式(例如,将顶级字段改为子字段,或将 errors 的位置改为内联)
  • 更改现有输入参数或输出值的名称或数据类型
  • 更改字段名称
  • 更改资源名称
  • 更改响应码
  • 更改错误类型
  • 更改现有授权范围

不破坏兼容性的更改

  • 新增一个端点
  • 新增一个可选参数
  • 新增一个响应字段
  • 更改错误消息中的文本
  • 提供新的 scope
  • 对字段进行“置空”(出于隐私/安全原因将某个值改为 null,作为不删除该字段的替代方案)

弃用与退役

首先,以下是我们对 X API 中“弃用”和“退役”的定义:

  • 弃用:该功能不再由团队维护。不会围绕该功能发布新的功能;如产品存在缺陷或问题,我们进行修复的可能性极低。 
  • 退役:该功能将不再可用。

在大多数情况下,一旦新版本发布,上一版本将被标记为弃用。各版本将在弃用状态下保留一段时间,之后将被退役。 

保持关注以了解未来的弃用与退役信息。