API固有識別子

現在、ほとんどのAPIは メソッドとパス で区別されている。ただし、一部の開発プロジェクト（例：一部のeコマースAPIドキュメント）では、APIリクエストに固定URLを使用し、Query/Headerのパラメータを使ってAPIを区別している。

バージョン2.2.9以降、ApidogはAPI固有識別子機能を追加し、OperationId、Queryパラメータ、Bodyパラメータ、Headerパラメータ をAPIの区別に使用できるようになった。

1. API固有識別子の設定

API固有識別子 は ディレクトリ レベルで定義される。APIを固有識別子として設定する場合は、その 親ディレクトリ で設定する必要がある。ディレクトリをクリックし、必要に応じて固有識別子パラメータを選択し、保存すると、そのディレクトリ配下のすべてのAPIに適用される。

この例では、Queryパラメータを選択し、パラメータ名に「OperationId」と入力する。

2. 固有識別子の対応するパラメータ値の入力

ディレクトリにAPI固有識別子を設定した後、そのディレクトリ配下のAPIをクリックし、operationid タブをクリックすると、APIの基本情報とリクエストパラメータの下部にKアイコンが表示される。これは API固有識別子 のパラメータを表している。

対応するパラメータの下に、API固有識別子の値として使用する値を入力できる。

3. インポート

プロジェクトでQuery/Headerのパラメータを使ってAPIを区別している場合、OpenFormat形式のファイルをApidogにインポートすると、次のページが表示される。

インポート時のAPI照合ルールは、対象ディレクトリの設定に従う。対象ディレクトリのAPI固有識別子の設定が要件を満たさない場合は、インポート設定で変更できる。変更後、対象ディレクトリに直接反映される。

例として、このディレクトリをインポートし、Query Param と Param Name で「action」というAPI固有識別子を作成する。

すでにディレクトリに固有識別子がある場合、新しいインポートでは上書きできないことに注意。

Queryパラメータで 固定値 を使用していたユーザーは心配無用。この機能は引き続き保持される。ただし、インポート時は 固定値 はURLに基づいて判断されるため、固定値 を使用していたユーザーはAPI固有識別子を使用することを推奨する

API固有識別子は複数のパラメータの設定をサポートしている

ディレクトリ内の一部のサブディレクトリのみが API固有識別子 として設定されている場合、Swaggerをインポートしてすべてのディレクトリを更新する際は、すべてのプロジェクトをルートディレクトリにインポートして更新することは避ける。API固有識別子 として設定されたAPIは、その特別なディレクトリに個別にインポートすることを推奨する

4. Mockデータ

バージョン2.2.24以降、APIが固有識別子を Bodyパラメータ または Headerパラメータ として設定している場合、対応するモックデータを取得するには パス＋固有識別子のパラメータ名と値 を送信する必要がある。

開発時にモックデータにアクセスする場合、フロントエンド開発者もAPIが Bodyパラメータ または Headerパラメータ を 固有識別子 として設定している場合は、パス＋固有識別子のパラメータ名と値 を送信する必要がある

APIに 固有識別子 があるプロジェクトでは、APIドキュメントを標準化し、同じURLを持つAPIに 固有識別子 が設定されていないケースを避ける必要がある。これは、モックデータを正しく取得できない事態を防ぐためだ

1. API固有識別子の設定#

2. 固有識別子の対応するパラメータ値の入力#

3. インポート#

4. Mockデータ#

1. API固有識別子の設定

2. 固有識別子の対応するパラメータ値の入力

3. インポート

4. Mockデータ