Skip to content

API 版本管理(计划中)

API 版本协商尚未上线。目前请求仍不带版本,并使用现有的兼容性行为。现在发送版本请求头或查询参数并不会选择某个带日期的契约,因此不要将任何一个值视为生产环境的固定版本。

API 参考描述了当前的行为。向后不兼容的版本日期、受支持版本列表、SDK 映射、弃用窗口和迁移指导将在协商功能上线时发布。

什么算作破坏性变更?

以下类型的变更可能需要未来推出一个带日期的 API 版本:

  • 移除或重命名请求或响应字段
  • 更改字段类型
  • 移除端点或参数
  • 以现有集成无法支持的方式更改端点行为
  • 移除文档中记录的兼容性别名

添加可选的响应字段或端点、改进校验消息,以及修复文档契约之外的行为,仍可保持非破坏性。

协商上线后选择 API 版本

直接调用 API 的客户端将通过 RRWeb-API-Version 请求头或 rrweb-api-version 查询参数选择一个文档中记录的带日期版本。

请求头:

http
RRWeb-API-Version: 2026-04-26

或通过查询参数:

text
?rrweb-api-version=2026-04-26

不要同时发送两种方式。上线文档将定义可接受的日期,以及值冲突或不受支持时的错误行为。官方 SDK 文档将说明每个 SDK 版本选择的 API 版本。

当某个版本被弃用时,rrweb Cloud 会在移除之前发布支持日期和迁移指导。不要根据本页上的示例日期推断支持窗口。