OpenAPI（Swagger）仕様のインポート

Apidogは OpenAPI 3 と Swagger-2 データ形式の json または yaml ファイルのインポートに対応している。

Swaggerファイル内に summary、operationId、path パラメータがすべて記述されている場合、インポート時にAPI名はsummary > operationId > path の優先順位で設定される。

ApidogはOpenAPI/Swagger仕様拡張のインポートをサポートしています。このドキュメントをクリックすると、ApidogがサポートするAPIフィールドを確認できます。

手動インポート

「設定」を開き、「データのインポート」をクリックして、ファイルインポートまたはURLインポートを選択する。

JSON または YAML ファイルを下図の領域にドラッグ＆ドロップするか、領域をクリックしてシステムのファイルマネージャーから目的のファイルを選択できる。

URLインポートを使用する場合は、Swagger UIのベースURLではなく、JSON または YAML データファイルの直接URLを提供する必要がある。

インポートされるOpenAPI/Swagger仕様には、API、Schema、環境のみが含まれる。

ファイルをインポートする際、以下のオプションを設定できる：

フォルダ：特定のフォルダへのファイルのインポートをサポート。

上書き：2つのファイルが同じメソッドとパスを持つ場合、新しいファイルが古いファイルを上書きする。

マージ：2つのファイルが同じメソッドとパスを持つ場合、Mockルール、パラメータの説明、リクエスト例、レスポンス例などの古いファイルからの変更情報が保持される。

選択したフィールドを上書き：2つのファイルが同じメソッドとパスを持つ場合、特定のフィールドの上書きを選択できる。選択されていない他のフィールドは、Apidog内の既存のデータを保持する。

無視：2つのファイルが同じメソッドとパスを持つ場合、新しいファイルはインポートされない。

両方保持：2つのファイルが同じメソッドとパスを持つ場合、新しいファイルがインポートされ、古いファイルは削除されない。

ケースのインポート：このオプションを有効にすると、選択したAPI配下のテストケースがデフォルトで自動選択される。インポートプレビューで対応するテストケースを手動で選択することもできる。

Schema は、上書きモードとインポートフォルダの選択を含め、個別に設定する必要がある。

Apidog内の既存のAPIの構造をインポートされるSwaggerファイルのフォルダ構造に合わせるには、フォルダも更新オプションを有効にする だけでよい。これにより、現在のフォルダ構造がインポートされたファイルに合わせて自動的に調整される。

「設定」パネルを開き、「データのインポート」に移動し、「スケジュール」をクリックする。ここで複数のデータソースを選択し、定期的に特定のフォルダに同期できる。

TIP

データのインポート オプションは、プロジェクト管理者のみが表示・アクセスできる。