OpenAPI仕様のインポート
このセクションでは、OpenAPI（Swagger）仕様をApidogにインポートする方法を学びます。
Apidogは、OpenAPI 3 および Swagger-2 データ形式の json または yaml ファイルのインポートをサポートしています。
summary、operationId、および path パラメータが同じSwaggerファイル内にすべて記述されている場合、インポート中にエンドポイント名は summary > operationId > path の優先順位に従って設定されます。
手動インポート
「設定」を開き、「データをインポート」をクリックして、ファイルインポートまたはURLインポートを選択します。
手動インポート - ファイルインポート
JSONまたはYAMLファイルを下記に示すエリアにドラッグ＆ドロップするか、エリアをクリックしてシステムのファイルマネージャーから目的のファイルを選択します。
手動インポート - URLインポート
URLインポートを使用する場合は、Swagger UIの基本URLではなく、JSONまたはYAMLデータファイルの直接URLを提供してください。
インポート - 高度な設定
インポートされたOpenAPI/Swagger仕様には、API、Schema、環境のみが含まれています。
ファイルをインポートする際に、以下のオプションを設定できます:
ディレクトリフォルダー: 特定のフォルダーにファイルをインポートすることをサポートします。
上書き: 2つのファイルが同じMethodとPathを持つ場合、新しいファイルが古いファイルを上書きします。
マージ: 2つのファイルが同じMethodとPathを持つ場合、Mockルール、パラメータ説明、リクエスト例、レスポンス例などの古いファイルからの変更情報が保持されます。
選択されたフィールドの上書き: 2つのファイルが同じMethodとPathを持つ場合、特定のフィールドを上書きできます。他の未選択のフィールドはApidogに既存のデータを保持します。
無視: 2つのファイルが同じMethodとPathを持つ場合、新しいファイルはインポートされません。
両方を保持: 2つのファイルが同じMethodとPathを持つ場合、新しいファイルがインポートされ、古いファイルは削除されません。
ケースのインポート: このオプションを有効にすると、選択されたエンドポイントの下のテストケースがデフォルトで自動的に選択されます。また、インポートプレビューで対応するテストケースを手動で選択することもできます。
Schema は、上書きモードの選択やインポートフォルダーの設定を含め、別途設定する必要があります。
Apidogで既存のエンドポイントの構造をインポートされたSwaggerファイルのフォルダ構造と一致させるために、「ディレクトリフォルダーの更新」オプションを有効にしてください。これにより、現在のフォルダー構造がインポートされたファイルに合わせて自動的に調整されます。
定期インポート
「設定」パネルを開き、「データをインポート」に移動し、「スケジュール」をクリックします。ここで複数のデータソースを選択し、指定されたフォルダーに定期的に同期することができます。
「データをインポート」オプションはプロジェクト管理者にのみ表示され、アクセス可能です。
