APIが積極的に進化している場合は、バージョン間の互換性を維持し、単一の変更が数十のクライアント統合を破る状況を回避することが重要です。お客様が変更を制御し、APIをユーザーにリスクなくスムーズに更新できるフルバージョンの契約を実装しています。
これは、マイクロサービスアーキテクチャ、B2B統合、および異なるクライアントが異なるバージョンのインターフェイスを使用するオープンAPI製品において重要です。
私たちがバージョン管理していること
| ［オブジェクト］ | Description（説明） |
|---|---|
| OpenAPIの仕様 | ドキュメントと契約のすべてのバージョンを保持する |
| エンドポイント（Endpoint） | URLにバージョンを追加（'/v1/'、 '/v2/'）、後方互換性を保存 |
| 契約（協定、Dredd） | クライアントとサーバー間の相互作用条件の修正 |
| データモデル | 要求と応答構造の変更を監視する |
どのように実装するか
複数のAPIバージョンを並列にサポート
URL、ヘッダー、またはパラメータ内の明示的なバージョン管理
各契約バージョンの自動テスト（Pact、 Postman、 Jest、 Dredd）
GitまたはCI/CD経由でのバージョン指定
各変更に関するお客様向けのドキュメントと変更履歴
利点
統合の安定性を保証
顧客を「壊す」リスクなしに新機能をリリースする能力
バージョン間の移行を簡素化
変更履歴と契約管理の明確化
社外および社内の開発チームの透明性
特に重要な点
多依存性マイクロサービスアーキテクチャ
パブリックまたはB2B APIプラットフォーム
長期契約による金融・決済システム
安定したAPIに依存するモバイルアプリ