APIの唯一の識別子
現在、ほとんどのAPIは通信方式 と pathに基づいて区別されています。ただし、一部の開発プロジェクト(例えば：ECのAPIドキュメント）では、固定なURLを使用し、QueryとHeaderにあるパラメータによってAPIを区別しています。
2.2.9 以降のバージョンでは、Apidogは APIの唯一の識別子機能を追加しました。 operationId、Queryパラメータ、 Bodyパラメータ及び Headerパラメータ はAPIを区別する唯一の識別子とすることをサポートできるようになります。
1. 唯一の識別子の設定
唯一の識別子 は、 ディレクトリレベルの設定に定義されます。 APIに唯一の識別子を設定したい場合、 親ディレクトリで設定する必要があります。必要に応じて唯一の識別子を選択し、「保存」をクリックすると、そのディレクトリの下のすべてのAPIに対して有効になります。
例： eコマースのAPIは、QueryパラメータのActionパラメータを唯一の識別子としたい場合、下記の画像に示すように、Queryパラメータを選択して、パラメータ名でactionを入力する必要があります。
2. 唯一の識別子のパラメータ値を入力
ディレクトリの唯一の識別子を設定した後、その下にあるAPIをクリックし、変更タブに切り替えると、APIの基本情報と下記のQueryパラメータの中にKアイコンが付いています。それは、当該 APIの唯一の識別子になります。
唯一の識別子の値として、対応するパラメータの下に対応する値を入力できます。
3. APIのページで唯一の識別子を表示
APIの変更ページで、APIの唯一の識別子の値を入力すると、APIページ及びオンラインAPIドキュメントで次の画像のように表示されるようになります。
4. インポート
Query/Headerのパラメータを使用してプロジェクト内のAPIを区別し、OpenAPI 形式のファイルをApidogにインポートすると、次のページが表示されます。
インポート中のAPIのルールの照会は、インポートのディレクトリの設定に左右されます。インポートのディレクトリ設定の唯一の識別子が要件を満たしていない場合は、インポート設定でそれを変更できます。変更後、このディレクトリ全体に対して直接有効になります
例：eコマースAPIは、Queryパラメータのactionパラメータを唯一の識別子として使用します。次のページで、変更をクリックして、Apidogにインポートするときに唯一の識別子を変更します。
ご案内：
- Queryパラメータの
固定値を使用したユーザーは、この機能は引き続き保持されるため、心配する必要はありません。ただし、インポート時に、固定値はURLに基づいて上書きの判断が行われるため、固定値を使用したユーザーは唯一の識別子も使用することをお勧めします。 - 唯一の識別子は、複数のパラメータをサポートします。
- ディレクトリ内に、いずれかのサブディレクトリのみが
唯一の識別子として設定されている場合、Swaggerをインポートしてすべてのディレクトリを更新しようとする時に、すべてのプロジェクトをルートディレクトリにインポートして更新しないようにしてください。唯一の識別子が設定されたAPIのみを当該サブディレクトリにインポートすることをお勧めします
5. Mockのデータ
バージョン2.2.24 以降、APIの唯一の識別子をBodyパラメータまたはHeaderパラメータとして設定している場合は、Mockのデータを取得するために、唯一の識別子のパラメータ名と値をPathと一緒に送信する必要があります。
ご案内：
- APIの
唯一の識別子をBodyパラメータまたはHeaderパラメータとして設定している場合は、フロントエンド開発者は、開発中にMockのデータを取得するために、唯一の識別子のパラメータ名と値をPathと一緒に送信する必要があります。 唯一の識別子があるプロジェクトでは、同じURLを持っているAPIに唯一の識別子が設定されない状況を避けるように、APIドキュメントを標準化にする必要があります。こうして、正確なMockデータを取得できないことが避けられます。