APIQIKAPIQIK
文档导航
计费与支持

版本与废弃策略

定义 API 稳定性、破坏性变更、模型别名、下线通知和迁移规则。

/v1 只在有明确兼容承诺时才具有价值。API 字段、模型版本和价格变化应分别管理,并为开发者保留可执行的迁移时间。

政策参数待确认通知周期、支持窗口和 SLA 数值必须由 Dimleap 产品与运营正式批准,本文不预设具体天数。

变更分类

类型示例发布要求
兼容性新增新增可选字段、模型或新端点。更新参考、示例和变更日志;客户端应容忍未知字段。
行为变化默认值、路由、限制、模型别名指向变化。说明影响范围、生效时间、验证和回滚方法。
破坏性变更删除字段、改变类型、停止端点。提前通知、提供迁移指南和并行支持窗口。
紧急安全变更修复漏洞或终止高风险能力。尽快处置,并在安全允许范围内说明影响与替代方案。

模型生命周期

  • 模型标记为 Preview、Stable、Deprecated 或 Retired。
  • 别名是否自动升级必须明确;需要可复现的业务应使用固定版本。
  • 下线公告提供替代模型、能力差异、价格差异、迁移示例和截止时间。
  • 模型被供应商紧急撤回时,状态页和更新日志应同步说明。

通知渠道

重大变更至少应同步到文档更新日志、控制台通知和账户联系人;企业用户可通过订阅或 Webhook 获取机器可读更新。所有时间使用明确时区。