スケジュールインポート（データソースのバインド）

スケジュールインポートは、外部ソースから Apidog に API 仕様を定期的に自動同期します。この機能は、API 仕様を外部システム（Git リポジトリや Swagger エンドポイントなど）で管理しつつ、手動で再インポートすることなく Apidog の強力なデバッグ機能とテスト機能を活用したいチームに最適です。

スケジュールインポートでは、次のことができます。

お好みのバージョン管理システムで API 仕様の信頼できる唯一の情報源を維持できます

カスタマイズ可能な間隔（30 分ごと、1 時間ごと、毎日など）で変更を自動同期できます

GitHub、GitLab、Azure DevOps、直接 URL など、複数のソースからインポートできます

手動操作なしで、最新の API 変更にチーム全体を同期できます

設定方法

設定に移動

Settings -> Import Data -> Scheduled Import (Bind Data Sources) に移動します。

データソースを作成

「New」をクリックして設定を追加します。

設定を構成

データソースの詳細（URL、頻度など）を入力します。Git リポジトリのバインドの詳細については、次のセクションを参照してください。

保存して有効化

Save をクリックします。これで、頻度設定に基づいてインポートが自動的に実行されます。

Apidog では、1 つのプロジェクト内に複数のデータソースを作成でき、それぞれを異なるフォルダーに同期およびインポートできます。

Git リポジトリのバインド

Apidog は、次の Git リポジトリのバインドをサポートしています。

Github

GitLab

Azure DevOps

Git リポジトリをバインドするには、次の手順に従ってください。

Bind Data Sources ダイアログボックスで Git Repository オプションを選択し、リポジトリ接続を作成します。

希望するバージョン管理プラットフォームを選択した後、手順に従って Apidog にリポジトリへのアクセス権を付与します。

Apidog にリダイレクトされて戻ったら、Organization と Repository を選択し、Save をクリックします。

最後に、Branch と OpenAPI Spec ファイルを選択し、バインドプロセスを完了します。

設定リファレンス

設定	説明
インポート頻度	Apidog がデータソースからの更新を確認し、インポートする頻度です。オプションには、30 分ごと、1 時間ごと、毎日、またはカスタム間隔が含まれます。
ソース形式	API ファイルの仕様形式です。サポートされる形式: `OpenAPI`（Swagger）、`ApiDoc`、または `Apidog` ネイティブ形式。
ソース URL	API 仕様ファイルへの直接 HTTP(S) リンクです。例: `https://petstore.swagger.io/v2/swagger.json`。公開アクセス可能であるか、Basic Auth で保護されている必要があります。
実行場所	インポートタスクの実行環境です。`Local Client`（アプリが開いているときに実行）または `Runner`（セルフホストサーバー上で 24 時間 365 日実行）を選択します。
Basic auth	ソース URL が HTTP Basic Authentication で保護されている場合のユーザー名とパスワードの認証情報です。公開 URL の場合は空のままにします。

その他のインポートオプションについては、インポートオプションを参照してください。

実行モード

スケジュールインポートでは、fetch コマンドを実行するための実行環境が必要です。ワークフローに最適なモードを選択してください。

1. ローカルクライアント（デフォルト）

インポートは、Apidog デスクトップアプリが開いている場合にのみ実行されます。

要件: 書き込み権限のある状態でプロジェクトを開いている必要があります。

制限: アプリまたはプロジェクトを閉じると、再度開くまで更新は一時停止されます。

ネットワーク: お使いのコンピューターからアクセスできる場合、内部ネットワーク URL にアクセスできます。

Apidog Web App でプロジェクトを開くことでも、スケジュールインポートがトリガーされます。ただし、ブラウザーのセキュリティ制限により、Web App は内部ネットワーク URL にアクセスできない場合があります。

2. セルフホスト Runner

インポートは、Apidog Runner をデプロイしたサーバー上で実行されます。

利点: オンラインかどうかに関係なく、24 時間 365 日実行されます。

ユースケース: 手動操作なしで一貫した更新が必要なチームに最適です。

セルフホスト Runner のデプロイについて詳しくご確認ください。

高度な設定: スプリントブランチへのインポート

インポート先として特定のスプリントブランチを指定できます。デフォルトでは、データは Main Branch にインポートされます。

詳細なワークフローについては、スプリントブランチへのデータのインポートを参照してください。

スケジュールインポート（データソースのバインド）

設定方法#

Git リポジトリのバインド#

設定リファレンス#

実行モード#

1. ローカルクライアント（デフォルト）#

2. セルフホスト Runner#

高度な設定: スプリントブランチへのインポート#

設定方法

Git リポジトリのバインド

設定リファレンス

実行モード

1. ローカルクライアント（デフォルト）

2. セルフホスト Runner

高度な設定: スプリントブランチへのインポート