API が市場の需要に対応し、技術的進歩を活用するために進化するにつれて、バージョン管理は不可欠になります。Open API は、技術チームがサービスやデータを外部に提供するための重要なチャネルです。しかし、ビジネスの発展と技術の進歩により、エンドポイントには必然的に複数のバージョン反復が生じます。この変化は、チームが機能を最適化し、新機能を導入し、バグに対処するうえで自然かつ必要なものです。複数の API バージョンを管理することは、互換性と革新性の両方を確保しながら、異なるユーザーグループにサービスを提供するために重要です。このアプローチにより、チームは安定して進化し続けるサービスを提供しつつ、バージョン管理を維持し、既存ユーザーへの影響を最小限 に抑え、ビジネスの継続性と信頼性を確保できます。
完全なバージョン作成既存の API バージョンを基に新しい API バージョンを作成でき、元のバージョンのすべてのエンドポイントのコピーが含まれます。作成後、バージョン内の各エンドポイントは必要に応じて変更できます。あるいは、空の API バージョンから開始し、エンドポイントを手動で追加することもできます。
包括的な共有プロジェクトから公開する API バージョンを 1 つ以上選択します。選択したバージョン内のすべてのエンドポイントがユーザーに表示されます。公開時には、読者体験を向上させるために、API バージョンの表示名と slug 設定を構成できます。
ワンクリック切り替え複数の API バージョンが公開されている場合、ユーザーは公開ページ上のプロジェクト名の横にあるバージョンセレクターを使用して、それらを切り替えることができます。バージョンをクリックすると、その特定のバージョンに関連するすべてのエンドポイントとコンテンツが表示されます。
「API バージョン」と「Sprint Branch」の違い
API バージョン: 外部リリース向けに設計されており、特に大きな変更によってバージョン間 に重大な非互換性が生じる場合に使用されます。変更または新規追加されたものだけでなく、すべてのエンドポイントを含みます
