Apidogは、シンプルなCLIコマンドを通じて、任意のCI/CDパイプラインで自動テストを実行することをサポートしています。GitHub Actions、GitLab CI、Jenkins、またはカスタムのWebhookハンドラーを使用している場合でも、Gitリポジトリが更新されるたびにApidogテストを自動的にトリガーできます。仕組み#
この統合は、シンプルな原則に基づいています:Git Webhook + CLI実行。Gitイベント(プッシュやプルリクエストなど)が発生すると、CI/CDツールがそのイベントを受け取り、apidog runコマンドを実行してテストシナリオを実行します。このガイドでは、広く使用されており追加のインフラが不要なGitHub Actionsを例とし て使用しますが、同じアプローチは他のプラットフォームにも適用されます。プッシュやプルリクエストごとにAPIテストを自動的に実行
特定のブランチ(例:main、develop)の監視
それでは、GitHub Actionsを使用したセットアップを見ていきましょう。ステップ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/
に保存されます。これはソースコードの一部であり、プロジェクトをローカルにクローンまたはプルする際に含まれます 。ローカル開発環境で編集し、他のファイルと同様にGitを通じて変更をコミットできます。ワークフローファイルの上部には、次のような行が含まれています:これは、誰かがコードをプッシュしたり、プルリクエストを開いたり更新したりするたびに、GitHubが自動的にワークフローをトリガーすることを示しています。これは、より冗長なバージョンと同等の短縮構文であり、ほとんどのCIシナリオでうまく機能します。ステップ4: ワークフローを実行して結果を確認#
設定が完了すると、新しいコードコミットがあるたびにGitHub Actionsワークフローが自動的に実行されます。Actionsページでワークフローのステータスとテスト結果を監視できます。 Modified at 2025-06-26 02:53:57