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

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

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

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

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

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

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

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

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

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

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

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

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

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

設定が完了したら、「公開」をクリックしてください。プロジェクト全体の状態が「公開」に変更され、外部ユーザーはApidogのプロジェクトアドレスを通じてドキュメントにアクセスし、異なるAPIバージョンを閲覧および切り替えることができます。

ステップ3：APIバージョンにおけるインターフェースの迅速な共有

APIバージョンを公表するだけでなく、任意のAPIバージョンから特定のインターフェースを迅速に共有することも可能です。

共有リンクを作成する際には、APIバージョンと共有したいインターフェースの範囲を選択します。

共有リンクを生成すると、外部ユーザーはそのAPIの指定されたインターフェースを表示できます。

ステップ4：APIバージョンの削除

すでに作成されたAPIバージョンは、メインブランチの「プロジェクト設定 -> APIバージョン」から削除できます。

削除後、公開されたドキュメントにはそのバージョンが含まれなくなり、関連する共有リンクも無効になり、ユーザーはそれらのリンクを通じて削除されたバージョンの内容にアクセスできません。

APIバージョン管理のFAQ

APIバージョンとスプリントブランチの違いは何ですか？

APIバージョン：主に外部公開に使用されます。古いバージョンと互換性のない重大な変更が発生した場合、新しいバージョンを作成することを推奨します。APIバージョンには完全なインターフェースのセットが含まれます。

スプリントブランチ：主にチーム内の開発反復に使用されます。各反復のためにブランチが作成され、完了後にメインブランチに統合されます。スプリントブランチには、通常、現在の反復から新しいおよび変更されたインターフェースのみが含まれます。

APIバージョン機能はすべてのタイプのインターフェースをサポートしていますか？

現在、この機能はHTTPインターフェースのみをサポートしています。

誰がAPIバージョンを作成および変更できますか？

プロジェクト管理者とプロジェクトエディターは、APIバージョンを作成および変更できます。

誰がAPIバージョンを公開または削除できますか？

APIバージョンを公開または削除できるのはプロジェクト管理者のみです。

関連リソースの変更がAPIバージョンに影響を与えますか？

いいえ。各APIバージョン内のリソースは独立しています。

多言語サポートなどのより多くの機能をサポートする計画はありますか？

はい、多言語サポートやクロスブランチ/バージョンプルなどの機能を積極的に開発しています。これらは将来のバージョンに展開され、API文書の管理効率をさらに向上させ、より多くのユーザーニーズに応えることを目指しています。

スプリントブランチの拡張についてはどうなっていますか？

スプリントブランチ機能のアップグレードが進行中であり、他のブランチからリソースをコピーする、他のブランチからリソースを選択する、ブランチのマージレビュー、ブランチのロックなどの機能を次回の更新でサポートする計画があります。

結論

Apidogが提供するAPIバージョン機能を通じて、チームは複数のAPIバージョンを効率的に作成および管理でき、古いバージョンの安定性を確保しながら新しい機能を導入できます。