跳转到内容

API 稳定性与版本管理

在长期基于 RealityConnect API 构建集成之前,请了解哪些部分是稳定的、实验性操作如何标记,以及每次升级后应关注哪些内容。


API 参考文档中的部分操作带有实验性稳定性标记。请在 OpenAPI 文档中查找操作上的 x-scalar-stability: experimental(在渲染后的 API 参考文档中会显示为稳定性徽章)来识别它们。该标记会自动与 API 保持同步,因此请以那里为准,而不要依赖本页的固定列表。

实验性操作是真实可调用的操作(并未被禁用,也不只是预览),但其路径、参数、请求体、响应或可用性可能会变化,且不具备与 API 其余部分相同的稳定性保证。关于如何使用它们,请参阅快速入门:实验性端点。

当某个实验性操作变为稳定时,会在发行说明中予以公告。

变更是否破坏性原因
新增可选请求参数否现有请求无需改动即可继续正常工作
新增响应字段否只读取已知字段的现有客户端不受影响;应以容错方式解析响应,并忽略无法识别的字段
为现有字段新增枚举值否应将枚举字段视为开放集合,灵活处理未知取值,而不是穷举匹配每个已知值
删除或重命名现有字段是会破坏读取该字段的所有客户端
修改现有字段的类型或含义是会破坏依赖旧结构的所有客户端
为现有操作新增必需参数是会破坏未发送该参数的现有请求
修改端点路径或 HTTP 方法是会彻底破坏现有请求
实验性操作的约定发生变化否(属于预期行为)实验性操作被明确排除在稳定性约定之外,参见上文
  • 查看 API 参考文档,了解每个操作当前的稳定性标记以及请求和响应架构。
  • 查看快速入门,了解安全模型以及如何选择 OAuth 流程。