CLIによるテストスイート実行

実行方式の選定

Apidog は、用途に応じて複数のテストスイート実行方法を提供しています。

ローカル可視実行

手元のマシンから起動する小規模・短時間の検証に適した方式です。

開発とテストを並行して進める場面で、状況を即時に把握しながら柔軟に調整できます。

ローカル Apidog CLI 実行

大量データや繰り返し実行のシナリオに向き、実行速度を重視する場合に適しています。

オフライン実行が可能で、GUI を用いない制約環境でも運用できます。

CI／CD 実行

CI／CD パイプラインに組み込み、自動統合・継続的デプロイに活用できます。

コード更新ごとに頻繁にテストを回して API の安定性を確認する運用に向いています。

セルフホスト型ランナー実行

チームのサーバー上に Apidogランナーを設置し、手元よりも強力な計算資源を活用できます。

スケジュール実行に対応し、定期実行や大規模テストにも適しています。

TIP

テストスイートで環境変数／グローバル変数を用いる場合、選択した実行方式によって値の実体が変わることがあり、結果の不一致につながる可能性があります。詳細はこちらを参照してください。

Apidog CLI 実行

Apidog CLIでテストスイートを実行するには、まずテストスイートを作成・構成します。その後、コマンドラインから Apidog CLI を用いて実行し、結果およびレポートを取得します。

テストスイート内で、CI／CD タブに切り替えます。

実行環境や通知方法などのパラメーターを設定します。画面での設定内容は、下部で生成される CLI コマンドにリアルタイムに反映されます。

CI／CD プロバイダー欄で、CLI コマンドラインまたは他のプラットフォームを選択します。

「アクセストークンを追加」をクリックし、「トークンの生成」で CLI 呼び出し認証用のトークンを発行します。詳細

コマンドをコピーしてコマンドラインに貼り付け、実行してテストの進行状況とレポートを確認します。

注意：コマンドを正常に実行するには、事前に Apidog CLIをインストールしてください。すでに導入済みの場合は最新版へ更新してください。

変数およびローカル設定ファイル（任意）

一部のシナリオでは、CLI 実行時にローカル設定ファイルが必要になります。

環境／グローバル変数

「ローカル値」を選択した場合、エクスポートした変数ファイルを CLI 実行マシンに配置し、--variables <path> でパスを指定してください。

「共有値」と「ローカル値」の違いは、実行方式をまたぐ環境変数/グローバル変数の利用ルールを参照してください。

データベース接続

テストでローカル保存の「データベース接続」を使用している場合、画面の案内に従って設定ファイルをエクスポートし、CLI 実行時に --database-connection <path> を指定します。

「データベース接続」は変数として保存しておくことを推奨します。これにより CLI 実行時に --database-connection <path> を追加する必要がなく、コラボレーションや保守も容易になります。詳細

CLI テストレポート

CLI 実行後、コマンドライン上でテストスイートの実行統計や、失敗したリクエストの検証・アサーション情報を含むテストレポートが得られます。

CLI を実行したフォルダー配下に、/apidog-reports/ フォルダーが生成され、HTML 形式の CLI テストレポートが保存されます。

コマンドオプション

Apidog CLI は、テストスイート実行を細かく制御できる多様なオプションを提供しています。詳細はApidog CLI オプションを参照してください。

CI／CD での Apidog CLI 利用

Apidog CLI は Jenkins、GitLab、GitHub Actions など各種パイプラインツールと統合できます。詳しくはCI/CD統合を参照してください。

CLIによるテストスイート実行

実行方式の選定#

Apidog CLI 実行#

変数およびローカル設定ファイル（任意）#

CLI テストレポート#

コマンドオプション#

CI／CD での Apidog CLI 利用#

実行方式の選定

Apidog CLI 実行

変数およびローカル設定ファイル（任意）

CLI テストレポート

コマンドオプション

CI／CD での Apidog CLI 利用