版本管理
Flex Forward API 以长期稳定性为设计目标。变更会谨慎进行,以避免破坏现有集成。当前版本
API 当前版本为 1.0.0。URL 中没有版本前缀 — 所有端点直接访问(例如POST /labels,而非 POST /v1/labels)。
向后兼容性
Flex Forward 团队致力于维护向后兼容性。现有集成会在 API 演进的同时持续运作。非破坏性变更
以下变更可能在未事先通知的情况下进行。您的集成应妥善处理:- 在请求体中新增可选字段
- 在响应体中新增字段
- 新增 API 端点
- 在响应字段中新增枚举值
- 为边界情况新增 HTTP 状态码
- 改善错误消息的清晰度
对 API 响应中的未预期字段,请忽略而非视为错误。对未知的枚举值也请妥善处理 — 例如,将无法识别的追踪
tag 视为 Unknown。这能确保您的集成对非破坏性新增具有韧性。破坏性变更
以下变更被视为破坏性且将事先通知:- 移除或重命名现有字段
- 变更现有字段的数据类型
- 移除 API 端点
- 变更身份验证机制
- 变更现有状态码的含义