定期インポート

API仕様をApidog外で管理しているが、APIのデバッグ、テスト、ドキュメント作成にApidogを使用したい場合は、定期インポート機能を利用できる。

定期インポートの作成

OpenAPI、ApiDoc、またはApidog形式のURLでAPI仕様を管理している場合、定期インポートを利用できる。

設定 - データのインポート - 定期インポートに移動する

「新規作成」をクリックしてデータソースを作成する

インポート頻度、データソースのURLなど、必要な情報を入力する

保存すると、設定したインポート頻度に従って定期インポートが実行される

定期インポートは以下のように動作する：デフォルトでは、定期インポートはローカルクライアントから開始される。まず、Apidogクライアントがデータソースにアクセスしてデータを取得し、それをApidogプロジェクトに更新する。

つまり：

定期インポートはプロジェクトがクライアントで開かれている場合のみ実行される。具体的には、プロジェクトの書き込み権限があり、このプロジェクトを開いており、前回の定期インポート実行からの経過時間が設定された間隔を超えている場合にのみ実行される

クライアントがデータソースアドレスに正常にアクセスできる限り、内部ネットワークのデータをApidogにインポートできる

したがって、プロジェクトが長時間開かれていない場合、定期インポートは機能しない。次回開かれたときにのみ更新される。

Apidog webでこのプロジェクトを開くと、定期インポートもトリガーされる。ただし、Webクライアントはブラウザのネットワーク環境による制限を受ける可能性があり、内部ネットワークにアクセスできない場合がある。

上記の問題を解決するため、Apidogは定期インポートの第二のメカニズムを提供している：インポートをローカルクライアントではなく、自己デプロイ型のランナーから開始できる。

サーバーにランナーをデプロイしている場合、クライアントが開いているかどうかに関係なく、ランナーが一定間隔でソースからデータを自動的にインポートする。

スプリントブランチへのデータの定期インポートが可能だ。デフォルトではメインブランチが選択される。別のスプリントブランチに切り替えると、設定したルールに従って定期的にそのブランチにデータがインポートされる。スプリントブランチへのデータインポートについて詳しく見る。

インポート頻度: インポートをトリガーする頻度。前回のインポートからの経過時間がこの期間を超えると、インポートがトリガーされる。

ソース形式: OpenAPI、ApiDoc、Apidog形式に対応。

ソース名: 任意の名前をつけて、異なるデータソースを区別する。

ソースURL: データソースのJSON/YamlファイルURL（例：https://petstore.swagger.io/v2/swagger.json）。

実行場所：定期インポートを開始する場所。デフォルトはローカルクライアント。ランナーをデプロイ後、ランナーを選択可能。

基本認証：暗号化されたURLにアクセスするために使用。

詳細設定：インポートオプションを参照。

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