v2
v2 总览
v2 版本占位页:尚未发布,未定义任何接口;说明新版本何时引入、与 v1 的关系。
/v2 尚未发布,本页是占位页。现在没有任何 v2 接口可调用,接入请使用 v1。
什么情况下会有 v2
只有破坏性变更才会引入新版本。具体指:
- 已有字段的语义或必填性需要改变;
- 已有端点的路径、参数位置或响应结构需要改变;
- 认证方式或受众划分需要改变。
允许在 v1 内完成的变更(新增端点、新增可选字段、新增错误码取值)不会催生 v2。
v2 发布后的形态
结构沿用 v1 的四层组织:版本 → 上下文 → 接口组。届时本页会替换为正式总览,内容包含:
| 内容 | 说明 |
|---|---|
| 上下文清单 | v2 保留哪些上下文、是否新增或合并 |
| 与 v1 的差异 | 逐条列出破坏性变更及迁移做法 |
| 并行期 | v1 与 v2 并行的时间窗口与下线计划 |
| 迁移指南 | 从 v1 迁移到 v2 的步骤与验证方式 |
现在该做什么
- 新接入:直接按 v1 实现;
- 已在用 v1:不需要为 v2 做任何准备,v2 的存在不会影响 v1 的行为;
- 关注变更:破坏性变更的预告会先出现在本页,再进入正式总览。