紹介
ApidogのAPIバージョン管理が、複数のAPIバージョンの管理を簡素化し、スムーズなアップデートと互換性を確保する方法をご紹介します。
現在では、オープンAPIは技術チームが外部にサービスやデータを提供するための重要な手段となっています。しかし、ビジネスが進化し、基盤技術が進歩するにつれて、チームが提供するAPIは必然的に複数のバージョンに変わることになります。この変化は避けられないものであり、チームは市場の要求と技術の進歩に応じて、既存の機能を最適化し、新しい機能を導入し、バグに対処する必要があります。
複数のAPIバージョンを管理することは、異なるユーザーグループに対応し、互換性と革新性を確保するために非常に重要です。このアプローチにより、チームはバージョン管理を維持しながら、安定した進化するサービスを提供できます。効果的な管理により、既存のユーザーへの影響を最小限に抑え、ビジネスの継続性と信頼性を確保します。
ユースケース
チームは、最新バージョン、安定バージョン、長期メンテナンスバージョンなど、複数のAPIバージョンを同時に提供する必要があるかもしれません。これにより、旧バージョンを使用しているユーザーへの影響を最小限に抑えることができます。
APIバージョン機能のハイライト
- 完全なバージョン作成
既存のAPIバージョンに基づいて新しいAPIバージョンを作成できます。元のバージョンのすべてのエンドポイントのコピーを含みます。作成後、バージョン内の各APIを必要に応じて変更できます。あるいは、空白のAPIバージョンから始め、APIを手動で追加することもできます。
- 包括的な共有
プロジェクトから1つ以上のAPIバージョンを選択して公開できます。選択したバージョン内のすべてのAPIがユーザーに表示されます。公開時に、APIバージョンの表示名とスラッグ設定を構成して、読者の体験を向上させることができます。
- ワンクリックでの切り替え
複数のAPIバージョンが公開されている場合、ユーザーは公開ページのプロジェクト名の横にあるバージョンセレクターを使用してそれらを切り替えることができます。バージョンをクリックすると、そのバージョンのすべての関連APIとコンテンツが表示されます。
「APIバージョン」と「スプリントブランチ」の違い
APIバージョン:特にAPIに大きな変更があり、バージョン間で重大な非互換性が生じる場合に、外部リリース用に設計されています。APIバージョンは、変更または新しく追加されたものだけでなく、すべてのAPIを含みます。
スプリントブランチ:アジャイル開発の「スプリント」の概念に沿って、開発チーム内で使用されます。各スプリントでは、通常、新規または変更されたAPIのみを含み、それ以外のAPIは除外されます。