指南

版本与变更策略

路径版本 + 废弃流程,避免第三方被动跟着改代码。

版本规则

  • URL 路径带主版本(/openapi/v1/**);同一主版本内只做向后兼容的增量变更。
  • 新增字段不视为破坏性变更;删除或语义变更字段会走废弃流程。
  • 废弃的接口在响应头返回 X-Api-Deprecated,并保证双版本共存不少于 6 个月

变更通知

  • 文档中心"变更日志"页公示每次变更;控制台与订阅回调会在破坏性变更前 30 天通知。