Apidog完全ガイド：APIバージョン管理で開発を加速

オープンAPIは、技術チームが外部ユーザーにサービスとデータを提供するための重要な手段です。ビジネスが発展し、技術が進化するにつれて、APIは定期的なバージョンの更新を必要とします。これらの更新は通常、市場の需要に応じたものや、既存の機能の最適化、新機能の追加、または脆弱性の修正を目指しています。

複数のバージョンが共存する中で、チームはそれぞれのバージョンが異なるユーザーのニーズに応えることを確認する必要があります。あるユーザーは最新のAPIバージョンを使用して新しい機能にアクセスする必要がある一方、他のユーザーは古いバージョンの安定性に依存するかもしれません。

実際には、チームは外部ユーザーに対して最新バージョン、安定バージョン、または長期サポートバージョンなど、複数のAPIバージョンを提供する必要があります。このアプローチは、異なるユーザーグループに対する互換性と安定性を確保し、古いAPIユーザーに対するアップグレードの影響を最小限に抑えます。

このようなシナリオに基づいて、Apidogは実用的な「APIバージョン」機能を提供しています。これにより、チームは異なるAPIバージョンを簡単に作成、管理、維持できるようになり、それぞれのバージョンが独立して機能し、他のバージョンと明確に区別されることが保証されます。

ボタン

ApidogにおけるAPIバージョン機能の使用

ステップ1：APIバージョンの作成

プロジェクトに入った後、プロジェクトディレクトリの上にあるブランチスイッチャーをクリックし、「バージョン内容」を選択して現在のプロジェクト内のすべてのAPIバージョンを表示します。「新しいAPIバージョン」をクリックし、名前を付けて初期コンテンツを選択します。

保存後、システムは自動的に新しいバージョンに切り替わり、このバージョン内のリソースを独立して編集できるようになり、元のバージョンに影響を与えることはありません。

ステップ2：ドキュメントでのAPIバージョンの公開

APIバージョンを作成した後、プロジェクト内の「ドキュメント共有 -> 公開設定」ページに移動して、公開したいAPIバージョンを選択します。

公開オプションを設定すると、選択したAPIバージョンがプロジェクトの公開アドレスに表示され、外部ユーザーがアクセスできるようになります。

「編集」ボタンをクリックして公開するAPIバージョンを選択します。バージョンのソース、表示バージョン番号、実行環境、およびスラグを設定できます。

💡

スラグは、公開アクセスアドレスに続く特定のAPIバージョンの一意の識別子として機能します。例えば、URL https://example.Apidog.cn/2-0-0 の場合、2-0-0がスラグであり、外部ユーザーはその特定のAPIバージョンに直接アクセスできます。これにより、各APIバージョンに一意で明確なアクセスパスが確保されます。

公開されたバージョンの順序も調整できます。最初にリストされているバージョンがデフォルトのバージョンになり、ユーザーがバージョンを指定せずにプロジェクトのアドレスにアクセスしたときに表示されます。