Apidog は、OpenAPI 3.0、OpenAPI 3.1、Swagger 2.0 のデータ形式に準拠した JSON または YAML ファイルのインポートに対応しています。Apidog は OpenAPI/Swagger の仕様拡張(Specification Extensions)の取り込みにも対応しています。Apidog がサポートする API フィールドは、こちらのドキュメントをご参照ください。インポート対象の設定#
対象ブランチ#
データを取り込む作業用ブランチを選択します(通常は main ブランチが既定)。インポート先#
新規の API やデータを 、既存のプロジェクト内モジュールに追加するか、新しいモジュールを作成して格納するかを選べます。API とケースの設定#
API ケースの自動生成#
取り込む API ドキュメントに具体的なテストケースが含まれていない場合、このオプションを有効にすると、各 API に対して既定の「Success」ケースを自動生成し、すぐにテストを開始できるようにします。OpenAPI/Swaggerのサーバーを環境として取り込む#
インポートするドキュメントに複数のサーバーアドレスが定義されている場合、このオプションを有効にすると、各アドレスをプロジェクト内の別々の環境として自動作成し、テスト対象の切り替えを容易にします。セキュリティと認証の取り扱い#
セキュリティスキーム(Security Scheme)は、OpenAPI などの API ドキュメントにおいて、API の認可方法を記述するための構成です。トークン、API Key、OAuth2 認可など、API にアクセスする際にクライアントがどのように認証情報を付与すべきかを示します。セキュリティスキームの取り込み#
この設定を有効にすると、ドキュメントで定義された各種セキュリティ設定(API Key、Basic Auth など)を Apidog の Auth 設定として取り込みます。・「Root」フォルダーの Auth を、OpenAPI仕様 で定義されたグローバルなセキュリティスキームとして設定することができます。
・セキュリティ未定義の API をどのように扱うかも指定できます(例:親フォルダーの Auth 設定を継承、または「認証なし」に設定)。命名規則とサマリー#
API の Summary フィールドが空の場合#
取り込んだ API に明確な名称(Summary)がない場合、Apidog は既定で operationId を API 名として使用します。パス名の使用や、説明文からの抽出に切り替えることも可能です。リソースの競合処理#
取り込むデータが、プロジェクト内の既存の API、データモデル、コンポーネントと重複する場合の扱いを指定します。API の競合#
同一の API(Method と Path が一致)を照合した際の動作:・上書き:新しく取り込んだ API で旧 API の内容を完全に置き換えます。
・両方を保持:両方の API をプロジェクト内に残します。
・無視:新しく取り込む側の競合 API を無視します。
・マージ:旧 API 側で変更した名称、モックルール、パラメーター説明、レスポンス例を保持します。
・選択フィールドのみ上書き:選択したフィールドだけを上書きし、未選択のフィールドは既存内容を維持します。Markdown・データモデル・コンポーネント#
Markdown、データモデル、コンポーネント の競合についても、「上書き」や「マージ」など同様のプルダウンオプションを利用できます。フォルダー同期#
同一の API が異なるフォルダーに存在する場合:
取り込んだ API が既存の API と一致する一方で、新旧ファイル間でフォルダー情報(フォルダー名、前/後処理 など)が異なるとき、以下から選べます。・既存の API フォルダーを変更しない:新しいファイル側のフォルダー情報を無視し、プロジェクトの元のフォルダー設定を保持。
・API のフォルダーを更新:新しいファイルのフォルダー情報で、該当 API の所属フォルダーを更新。リソースのクリーンアップ#
Apidog は、新しく取り込むファイルとプロジェクト内の既存リソースを比較します。・削除しない:新しいファイルに存在しない既存リソースもそのまま保持します(安全な選択)。
・削除する:新しいファイルに存在しない既存リソースを削除します(同期の選択。取り込み元データとの完全一致を保証)。URL インポート#
URL でインポートする場合は、Swagger UI のベース URL ではなく、JSON または YAML のデータファイルに直接アクセスできる URL を指定してください。URL でのインポート時、一部の URL は Basic 認証で保護されている場合があります。その際は、Basic 認証のトグルをオンにして、ユーザー名とパスワードを入力してください。定期インポート#
「設定」パネルを開き、 「データのインポート」に移動し、「スケジュール」をクリックする。ここで複数のデータソースを選択し、定期的に特定のフォルダに同期できる。データのインポート オプション は、プロジェクト管理者のみが表示・アクセスできる。