基本認証#
URLを使用してインポートする場合、一部のURLは基本認証による暗号化を使用している場合がある。この場合、基本認証のトグルをオンにして、ユーザー名とパスワードを入力するだけでよい。インポート対象の設定#
対象ブランチ#
データを取り込む作業ブランチを選択します。通常は「main」ブランチが既定です。取り込み先#
新規のAPIや各種データを、プロジェクト内の既存モジュールへ追加するか、新規モジュールを作成して格納するかを選べます。APIとケースの設定#
APIケースを自動生成#
取り込むAPIドキュメントに具体的なテストケースが含まれていない場合、このオプションを有効にすると、Apidogが各APIに既定の「Success」ケースを自動生成し、すぐにテストを開始できます。OpenAPI/SwaggerのServersを環境として取り込む#
取り込むOpenAPI/Swagger仕様書に複数のサーバーアドレスが定義されている場合、このオプションを有効にすると、プロジェクト内にそれぞれを別環境として自動作成し、テスト対象の切り替えが容易になります。セキュリティと認証の取り扱い#
セキュリティスキーム(Security Scheme)は、OpenAPIなどのAPIドキュメントで、APIの認可方法を記述するための設定です。
クライアントがAPIへアクセスする際に、トークン、API Key、OAuth2による認可など、どのように認証情報を付与するかを示します。セキュリティスキームの取り込み#
この設定を有効にすると、資料で定義された各種セキュリティ設定(API Key、Basic認証など)がApidogの認証設定に取り込まれます。「Root」フォルダーの認証として、OpenAPI仕様書で定義されたグローバルなセキュリティスキームを採用できます。
セキュリティが未定義のAPIについては、取り扱い方針を指定できます(例:親フォルダーのAuthを継承/認証なしに設定)。
命名規則とサマリー#
APIのサマリーが未入力の場合#
取り込んだAPIに明確な名称(「Summary」)がない場合、Apidogは既定で「operationId」の値をAPI名として用います。パスを用いる、または説明文から名称を抽出することも選択できます。リソースの競合処理#
取り込むデータが、プロジェクト内の既存APIやデータモデル、コンポーネントと重複する場合の扱いを選択します。APIの競合#
同一API(メソッドとパスで判定)が見つかった場合の挙動:上書き:新規に取り込むAPIで既存の内容を完全に置き換えます。
両方保持:両方のAPIをプロジェクト内に残します。
マージ:既存API側の変更済み名称、モックルール、パラメーター説明、レスポンス例を保持します。
選択項目のみ上書き:選択したフィールドだけを上書きし、未選択の項目は現状を維持します。
Markdown、データモデル、コンポーネント#
Markdownファイル、データモデル、コンポーネントの競合についても同様に、「上 書き」や「マージ」などの選択肢がドロップダウンで利用できます。フォルダーの同期#
取り込んだAPIが既存のAPIと一致する一方で、新旧ファイル間でフォルダー情報(フォルダー名、前/後処理 など)が異なる場合、以下から選べます。既存APIのフォルダーを維持:新ファイル側のフォルダー情報は無視し、プロジェクトの元のフォルダー設定を保持します。
APIのフォルダーを更新:新ファイルのフォルダー情報で、プロジェクト内の所属フォルダーを更新します。
リソースのクリーンアップ#
Apidogは、新規に取り込むファイルとプロジェクト内の既存リソースを比較します。削除しない:新ファイルに存在しない既存リソースは残します(安全策)。
削除する:新ファイルに存在しない既存リソースを削除します(同期策。取り込み元データと完全に整合させます)。
Modified at 2025-11-25 10:47:01