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