Apidog は、シンプルな CLI コマンドを通じて、任意の CI/CD パイプラインで自動テストを実行することをサポートしています。GitHub Actions、GitLab CI、Jenkins、またはカスタム Webhook ハンドラーのいずれを使用している場合でも、Git リポジトリが更新されるたびに Apidog のテストを自動的にトリガーできます。前提条件#
テストシナリオが作成済みの Apidog アカウント
仕組み#
この連携は、Git Webhook + CLI 実行というシンプルな原則に基づいています。Git イベント（push や pull request など）が発生すると、CI/CD ツールがそのイベントを受信し、apidog run コマンドを実行してテストシナリオを実行します。このガイドでは、広く利用されており追加のインフラストラクチャを必要としないため、GitHub Actions を例として使用します。ただし、同じアプローチは他のプラットフォームにも適用できます。すべての push または pull request で API テストを自動的に実行する
特定のブランチ（例: main、develop）を監視する
ステップ 1: GitHub ワークフローを初期化する#
3.
上部ナビゲーションバーの 「Actions」 タブをクリックします。
4.
このリポジトリで Actions を設定するのが初めての場合は、「New workflow」 をクリックして作成します。
ステップ 2: Apidog で GitHub Actions 設定を生成する#
1.
Apidog でプロジェクトを開き、「Tests」 ページに移動します。
3.
テスト環境を設定し、テストデータを有効にするかどうかを決定し、ループ回数と遅延間隔を設定します。
4.
「GitHub Actions」 を選択し、「Copy」 をクリックします。
ステップ 3: GitHub にワークフローを貼り付けてコミットする#
1.
GitHub リポジトリに戻り、Actions ページを開きます。
2.
新しいワークフローを作成し、Apidog からコピーした設定コードを貼り付けます。
3.
既存の CI パイプラインがすでにある場合は、Apidog のテスト設定をそこにマージできます。
4.
「Commit changes」 をクリックして、ワークフローを保存して有効にします。
.github/workflows/ に保存されます。
これはソースコードの一部であり、プロジェクトをローカルに clone または pull した際に含まれます。他のファイルと同様に、ローカル開発環境で編集し、Git を通じて変更をコミットできます。ワークフローファイルの先頭には、次のような行が含まれています。これは、誰かがコードを push したり、pull request を作成または更新したりしたときに、GitHub がワークフローを自動的にトリガーすることを示しています。これは、より詳細な記述と同等の短縮構文であり、ほとんどの CI シナリオで適切に機能します。ステップ 4: ワークフローを実行して結果を確認する#
設定が完了すると、新しいコードコミットがあるたびに GitHub Actions ワークフローが自動的に実行されます。ワークフローのステータスとテスト結果は、Actions ページで監視できます。 Modified at 2026-06-11 07:06:02
