現在、ほとんどの API は メソッドとパス に基づいて区別されています。しかし、一部の開発プロジェクト（一部の EC API ドキュメントなど）では、API リクエストに固定 URL を使用し、Query / Header のパラメータを使用して API を区別しています。バージョン 2.2.9 以降、Apidog は エンドポイントの一意識別 機能を追加しました。この機能は、API を区別するためのパラメータとして、OperationId、Query パラメータ、Body パラメータ、Header パラメータ をサポートしています。エンドポイントの一意識別の設定#
エンドポイントの一意 ID は ディレクトリ レベルで定義されます。API を一意識別として設定する必要がある場合は、その API の 親ディレクトリ で設定する必要があります。ディレクトリをクリックし、必要に応じて一意識別パラメータを選択します。保存をクリックすると、そのディレクトリ配下のすべての API に適用されます。この例では、Query パラメータを選択し、パラメータ名に OperationID を入力します。対応するパラメータ値の入力#
ディレクトリにエンドポイントの一意識別を設定した後、そのディレクトリ配下の API をクリックし、operationid タブをクリックします。API の下部にある基本情報とリクエストパラメータの両方に K のアイコンが表示されます。これは エンドポイントの一意 ID のパラメータを表します。対応するパラメータの下に、エンドポイントの一意識別の値として対応する値を入力できます。一意識別を使用したインポート#
プロジェクト内で Query/Header のパラメータを使用して API を区別しており、OpenAPI 形式のファイルを Apidog にインポートする場合、次のページが表示されます。インポート時の API マッチングルールは、対象ディレクトリの設定に従います。対象ディレクトリのエンドポイントの一意識別設定が要件を満たしていない場合は、インポート設定で変更できます。変更後、その設定は対象ディレクトリに直接適用されます。例として、このディレクトリをインポートし、Query Param としてエンドポイントの一意 ID を作成し、Param Name を action とします。ディレクトリにすでに一意 ID がある場合、新しいインポートで上書きすることはできない点に注意してください。
1.
Query パラメ ータで Fixed Value を使用しているユーザーは心配する必要はありません。この機能は引き続き保持されます。ただし、インポート時には Fixed Value は URL に基づいて判定されるため、Fixed Value を使用しているユーザーには、エンドポイントの一意識別を使用することを推奨します。
2.
エンドポイントの一意識別では、複数のパラメータ の設定をサポートしています。
3.
ディレクトリ内のサブディレクトリのみが エンドポイントの一意識別 として設定されている場合、Swagger をインポートしてすべてのディレクトリを更新する際は、更新のためにすべてのプロジェクトをルートディレクトリにインポートすることは避けてください。エンドポイントの一意識別 として設定された API は、その特別なディレクトリに個別にインポートすることを推奨します。
モックデータ#
バージョン 2.2.24 以降、API で 一意識別子 が Body Parameter または Header Parameter として設定されている場合、対応するモックデータを取得するには、パス + 一意識別子のパラメータ名と値 を送信する必要があります。1.
開発中にモックデータへアクセスする場合、API で 一意識別子 が Body Parameter または Header Parameter として設定されている場合は、フロントエンド開発者も パス + 一意識別子のパラメータ名と値 を送信する必要があります。
2.
API に 一意識別子 が設定されているプロジェクトでは、同じ URL を持つにもかかわらず 一意 識別子 が設定されていない API が存在するケースを避けるため、API ドキュメントを標準化する必要があります。これは、モックデータを正しく取得できない事態を避けるためです。
