Apidog CLIのインストールと実行

Apidog CLIは、コマンドラインでApidogのテストシナリオを実行するために設計されているよ。Apidog CLIを使い始めるには、まずNode.jsをインストールしてからApidog CLIをインストールしよう。それから、テストシナリオを実行できるよ。

Apidog CLIのインストール

Apidog CLIはNode.js上で動作するから、使う前にNode.jsをインストールしてね。

Apidog CLIはNode.jsのバージョンがv16以上であることが必要だよ。

システムにnpmからグローバルにApidog CLIをインストールして、どこからでも実行できるようにしよう：

Apidog CLIが正しくインストールされたか確認するためのコマンドは以下の通り：

これらのコマンドを実行すると、インストールが成功していればバージョン番号とインストールパスが表示されるよ。

Apidog CLIのアップデート

以下のコマンドを使ってApidog CLIをアップグレードしよう。

Apidog CLIの実行

Apidog CLIを使ってテストシナリオを実行するには、まずテストシナリオを作成してオーケストレーションする必要があるよ。それから、コマンドラインからApidog CLIを使ってテストシナリオを実行し、テストレポートを取得できるよ。

Apidog CLIは2つの実行方法をサポートしている：

オンラインデータでの実行: ライブシナリオに適しているよ。

エクスポートされたテストシナリオでの実行: オフラインシナリオに適しているよ。

オンラインデータをリアルタイムで実行

テストシナリオで、CI/CDタブに切り替える。

環境、テストデータ、繰り返し回数、遅延などを設定する。

CI/CDプロバイダーセクションで「コマンドライン」を選択する。

「アクセストークンを追加」ボタンをクリックして、「トークンを生成」を選択する。

アクセストークンについてもっと知る。

コマンドをクリックしてコピーする。

コマンドラインに貼り付けて実行する。コマンドラインでテストレポートが得られるよ。

Step 2で設定した内容は、CLIで使用されるオプションと値を自動的に決定するよ：

環境: -e <environmentId>に対応。

テストデータ: -d <testDataId>に対応。

繰り返し回数: -n <n>に対応。

遅延: --delay-request <n>に対応。

環境/グローバル変数: 現在の値をエクスポートして使用するを選択した場合、プロジェクトから環境/グローバル変数の現在の値をファイルにエクスポートするためのオプションが表示されるよ。これは--variables <path>に影響する。このファイルをCLIを実行するマシンにインポートし、そのパスを--variables <path>で指定する必要があるよ。「初期値を使用」と「現在の値をエクスポートして使用する」の違いについてはこちらで詳しく学べるよ。

テストシナリオでローカルに保存されたデータベース接続設定を使用する場合、製品インターフェースがこれらの設定をローカルファイルにエクスポートするように案内するよ。これは--database-connection <path>に影響する。このエクスポートされたファイルをCLIを実行するマシンにインポートし、そのパスを--database-connection <path>で指定する必要があるよ。

エクスポートデータを実行

テストシナリオで、CI/CDタブに切り替える。

環境、テストデータ、繰り返し回数、遅延などを設定する。

CI/CDプロバイダーで「コマンドライン」を選択し、「エクスポートデータを実行」に切り替える。

テストシナリオをJSONファイルとしてエクスポートする。

表示されたコマンドをコピーする。

コマンドラインに貼り付けて実行する。コマンドラインでテストレポートが得られるよ。

Step 2の設定（「オンラインデータを実行」など）は、CLIで使用されるオプションと値に自動的に影響するよ。この方法で実行する場合、環境/グローバル変数はテストシナリオと一緒にエクスポートされたファイルの値を使用するよ。詳しくはこちらで学べるよ。

CLIテストレポート

CLIを実行した後、テストシナリオの実行統計や失敗したリクエストの検証とアサーションを含むコマンドラインテストレポートが得られるよ。

CLIを実行したフォルダには、/apidog-reports/ディレクトリがあり、そこにはHTML形式のCLIテストレポートが含まれているよ。

オプション

Apidog CLIは、コレクションの実行をカスタマイズするための豊富なオプションを提供しているよ。Apidog CLIオプションで詳しく学べるよ。

CI/CDでのApidog CLIの使用

Apidog CLIは、Jenkins、GitLab、GitHub Actionsなどのさまざまなパイプラインツールとの統合をサポートしているよ。CI/CDの統合についてもっと知る。

Apidog CLIのインストールと実行