最終更新：
Click to expand / collapse
APIが進化するにつれて、新しいメソッド、パラメータ、ロジックが登場します。現在のクライアントの作業を中断しないために、APIバージョニングが使用されます。私たちは、バージョン管理へのいくつかのアプローチをサポートしており、インテグレータは安定した運用のためのリスクなしに、目的のバージョンのインターフェイスを使用することができます。
これは、プラットフォームのスケーリングと、古いクライアントの更新、テスト、サービスの実装の両方において重要です。
バージョン管理方法
| メソッド | 説明と利点 |
|---|---|
| URLのバージョン（'/v1/'） | 最もわかりやすく人気のある方法は、REST APIにとって便利です |
| ヘッダーを受け入れる | 例：'Accept： application/vnd。api+json；version=2'-データをバージョンから分離 |
| GraphQLエイリアス/バージョン管理フィールド | エイリアスによる異なるバージョン：'userV1'、 'userV2'-段階的な移行に便利 |
| スキーマレベルのバージョン | バージョンごとにOpenAPI/Swaggerのダイアグラムとモジュールを分離 |
どのように実装されて
'/v1/'、 '/v2/'と独立したルートを持つAPI構造
"Accept'と"X-API-Version"ヘッダーのチェック
GraphQLはエイリアスとバージョン管理されたスキーマ（'userV1'、 'userV2'）をサポートしています')
A/Bのテスト能力生産への危険なしの新しい版
解析と移行のための各バージョンへの呼び出しのログ
ビジネスとインテグレータのメリット
減速せずに古い顧客をサポート
マルチジェネレーションAPIパラレル動作
後方互換性を損なうことなく安全に新機能を実装
インフラストラクチャの拡張とアップグレードの柔軟性
制御バージョンと分析バージョンのシームレスな移行
特に重要な点
複数の外部クライアントを持つプラットフォーム
APIファーストアプローチと長いライフサイクルを持つプロジェクト
銀行、プロバイダー、B2Bパートナーとの統合
長寿命のモバイルまたはIoTクライアントを持つシステム