ZOLOZ サービスは、HTTP URI パスにバージョン番号を含める方法で API をバージョン管理します。たとえば、https://zoloz_api_host/api/v1/products です。
通常、互換性のある変更は既存のバージョンの API に導入される可能性がありますが、互換性のない変更が導入される場合は新しいバージョンの API が提供されます。
新しいバージョンがリリースされると、お客様は既存のバージョンを引き続き使用するか、新しいバージョンにアップグレードするかを選択できます。既存のバージョンを引き続き使用する場合は、API への互換性のある変更を適切に処理する必要があります。
既存のバージョンに対する互換性のある変更の可能性は次のとおりです。
リクエストに新しいオプション フィールドが追加されます。
リクエスト フィールドに新しい有効な値が定義されます。
リクエスト フィールドに許可される最大長が増加します。
レスポンスに新しいフィールドが追加されます。
リクエストまたはレスポンスのフィールドの順序が変更されます。