API 兼容性

ZOLOZ 服务标记 API 版本的方法是在 HTTP URI 中增加版本号。

例如,https://zoloz_api_host/api/v1/products

通常可兼容的变更会引入到现有版本 API 中,但有不兼容的变更引入时,就会发布新版本的 API。

新版本发布后,客户可以选择继续使用现有版本,也可以选择升级至新版本。若继续使用现有版本,客户必须正确处理现有版本的可兼容变更。

现有版本的可兼容变更可能存在以下几种情形:

  • 请求中新增可选字段。
  • 在请求字段中新增有效值定义。
  • 请求字段的最大长度变长。
  • 响应中新增字段。
  • 请求或响应中调整字段顺序。