メインコンテンツまでスキップ

Apidog CLIコマンドのオプション

Apidog CLIは、Apidogのコマンドラインツールであり、主にAPIテスト自動化を行うために利用されます。

##　CLIのインストール

Apidog CLIは、Node.jsに依存しています。CLIツールを利用するには、まずはNode.js V10以上のバージョンがインストールされていることを確保してください。

npm install -g apidog-cli@latest

コマンドのオプション​

コマンドラインのパラメータ​

apidog [options]​

  • -h, --help ヘルプ情報を見る

  • -v, --version Apidogのバージョン号を表示する

apidog run <file-source> [options]​

file-source は、Apidogからエクスポートした test cases ファイルの保存パスです。

そのほかのオプション：​

オプション説明
-r, --reporters [レポーター]テストレポートのフォーマットを指定 (デフォルト: cli)
-n, --iteration-count 反復実行回数を設定
-d, --iteration-data <パス>反復実行のためのデータ(JSON/CSV)を設定
--external-program-path <パス>外部プログラムのパスを指定 (デフォルト: カレントディレクトリ)
--out-dir <ディレクトリ>テストレポートの出力ディレクトリを指定 (デフォルト: apidog-reports)
--out-file <ファイル>テストレポートのファイル名を指定 (拡張子不要)
--database-connection <パス>データベース接続設定ファイルのパスを指定 (URLテストで必須)
--ignore-redirectsリダイレクト応答の自動フォローを無効化
--silentコンソール出力を抑制
--color <値>コンソールの色出力のon/offを指定 (デフォルト: auto)
--delay-request [n]リクエスト間の遅延時間を指定(ミリ秒) (デフォルト: 0)
--timeout-request [n]リクエストのタイムアウトを指定(ミリ秒) (デフォルト: 0)
--timeout-script [n]スクリプトのタイムアウトを指定(ミリ秒) (デフォルト: 0)
-k, --insecureSSL証明書検証を無効化
--ssl-client-cert-list <パス>SSLクライアント証明書リスト(JSON)のパスを指定
--ssl-client-cert <パス>クライアント証明書(PEM)のパスを指定
--ssl-client-key <パス>クライアント秘密鍵のパスを指定
--ssl-client-passphrase <パスワード>秘密鍵のパスフレーズを指定
--ssl-extra-ca-certs <パス>追加CA証明書(PEM)のパスを指定
--verbose詳細情報を出力
-h, --helpヘルプを表示

SSL​

クライアント証明書​

apidog CLIは、クライアント証明書の受け渡しをサポートしています。

単一のSSLクライアント証明書の使用：​

  • --ssl-client-cert 共通 SSLクライアント証明書ファイルのパスを特定する

  • --ssl-client-key プライベートSSLクライアント証明書のパスを特定する（オプション）

  • --ssl-client-passphrase SSLのクライアントのパスフレーズを特定する（オプション）

SSLクライアント証明書の設定ファイルの使用(複数の証明書をサポート)​

  • --ssl-client-cert-list SSLのクライアント証明書リストからJSONファイルのパスを特定する。例えば：ssl-client-cert-list.json
ssl-client-cert-list.json

[
    {
        "name": "domain1",
        "matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
        "key": {"src": "./client.domain1.key"},
        "cert": {"src": "./client.domain1.crt"},
        "passphrase": "changeme"
    },
    {
        "name": "domain2",
        "matches": ["https://domain2.com/*"],
        "key": {"src": "./client.domain2.key"},
        "cert": {"src": "./client.domain2.crt"},
        "passphrase": "changeme"
    }
]

このオプションは、URLまたはホスト名によって異なるSSLクライアント証明書の設定をサポートします。これは --ssl-client-cert、--ssl-client-key、 --ssl-client-passphrase オプションより優先されています。リスト内のURLがマッチしない場合、これらのオプションはフォールバックオプションとして使用されています。

バージョンアップ​

CLIは次のコマンドを使用してApidogのバージョンをアップグレードします：

$ npm install apidog-cli@latest -g