ZOLOZZOLOZDOCS

API兼容性

ZOLOZ服务通过在HTTP URI中增加版本号来标记API的版本，例如https://zoloz_api_host/api/v1/products。

通常可兼容的变更会引入到现有版本的API中，当有不兼容的变更引入时，就会发布新版API。新版API发布后，客户可以选择继续使用现有版本或升级至新版本。如果继续使用现有版本，客户必须正确处理现有版本的可兼容变更。

现有版本的可兼容变更存在以下几种情况：

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