Apidog CLI オプション
Apidog CLI の基本構文
apidog run --access-token <value> [options]apidog run --access-token $APIDOG_ACCESS_TOKEN -t 637132 -e 358171 -d 3497013 -r html,cli --database-connection ./database-connections.jsonapidog run <collection> [options]apidog run examples/sample.apidog-cli.json -r cli,htmlオプション
| オプション | 説明 |
|---|---|
--access-token <accessToken> | オンライン実行用の認証トークンを設定 |
-t, --test-scenario <testScenarioId> | 実行するテストシナリオIDを指定 |
-f, --test-scenario-folder <folderId> | 実行するテストシナリオディレクトリIDを指定 |
-r, --reporters [reporters] | テストレポートの種類を指定（デフォルト: ["cli"]） |
--out-dir <outDir> | テストレポートの出力ディレクトリ（デフォルト: "./apidog-reports"） |
--out-file <outFile> | テストレポートの出力ファイル名 |
--out-json-failures-separated <outJsonFailuresSeparated> | 失敗を別のJSONファイルとしてエクスポート |
-e, --environment | 実行環境を指定 |
-n, --iteration-count <n> | 繰り返し回数を設定 |
-d, --iteration-data <path> | ケース繰り返し用のデータを設定（JSONまたはCSV） |
--variables <path> | 指定されたパスのファイルから環境/グローバル変数を使用し、環境/グローバル変数の初期値を使用しない。 |
--global-var <value> | グローバル変数を設定（key=value形式） |
--env-var <value> | 環境変数を設定（key=value形式） |
--external-program-path <path> | 外部プログラムのファイルパスを指定 |
--database-connection <path> | データベース設定のファイルパスを指定 |
--ignore-redirects | 自動リダイレクトを防止 |
--silent | コンソール出力を防止 |
--color <value> | カラーコンソール出力を有効/無効 |
--delay-request [n] | リクエスト間の遅延を指定（ms） |
--timeout-request [n] | リクエストタイムアウトを指定（ms） |
--timeout-script [n] | スクリプト実行タイムアウトを指定（ms） |
-k, --insecure | SSL検証を無効 |
--ssl-client-cert-list <path> | クライアント証明書設定ファイルのパスを指定 |
--ssl-client-cert <path> | クライアント証明書のパスを指定（PEM） |
--ssl-client-key <path> | クライアント証明書の秘密鍵パスを指定 |
--ssl-client-passphrase <passphrase> | クライアント証明書のパスフレーズを指定 |
--ssl-extra-ca-certs <path> | 追加の信頼できるCA証明書を指定 |
-b, --bigint | bigint互換性を有効 |
--upload-report [value] | テストレポートの概要をクラウドにアップロード |
--preferred-http-version <preferredHttpVersion> | 優先HTTPプロトコルバージョンを設定 |
--verbose | 詳細なリクエストとレスポンス情報を表示 |
--lang <language> | CLIの言語を設定（en） |
-h, --help | ヘルプ情報を表示 |
CLIでのファイルアップロード
必要なファイルを事前にCLIを実行するマシンにコピーします。
CLIマシン上のファイルパスをコピーします。
Apidogのテストシナリオで、ファイルアップロードリクエストのステップ詳細を開き、「一括編集」ボタンをクリックします。
ファイルフィールドのパラメータ値をCLIマシン上のファイルパスに置き換えます。
CLIでのデ ータベース操作の使用
データベース操作を含むテストシナリオの場合、コマンドライン生成インターフェースに「データベース設定ファイルをダウンロード」というプロンプトが表示されます。
このファイルをダウンロードし、Apidog CLIを実行する予定のディレクトリに配置します。
自動生成されたコマンドラインには
--database-connectionオプションが含まれます。このコマンドラインをそのまま使用してテストを実行できます。ローカルCLIテストレポートをクラウドにアップロード
--upload-reportパラメータを追加します。以下はその方法です：CLIコマンドに
--upload-reportパラメータを追加します：apidog run --access-token $APIDOG_ACCESS_TOKEN -t 637132 -e 358171 -d 3497013 -r html,cli --upload-reportこのコマンドはテストを実行し、完了後にテストレポートを自動的にクラウドにアップロードします。
アップロードされたレポートを表示するには：Apidogダッシュボードの「テストレポート」セクションに移動します。 「チームレポート」列を探します。
注意：CLI経由でアップロードされたレポートの場合、「テスター」フィールドは空として表示されます。
CLIでの外部スクリプト/プログラムの使用
--external-program-path ./scripts./scriptsディレクトリにあるプログラムを参照するように指示しています。階層が指定されていない場合、デフォルトは現在のCLI実行ディレクトリです。1.
ローカルスクリプトの管理における混乱を避けるために、以下のことを推奨します：
2.
または、以下のこともできます：
SSL
クライアント証明書
単一のSSLクライアント証明書の使用
--ssl-client-certSSLクライアント証明書の公開鍵のパスを指定します。
--ssl-client-keySSLクライアント証明書の秘密鍵のパスを指定します（オプション）。
--ssl-client-passphrase SSLクライアントのパスフレーズを指定します（オプション）。
SSLクライアント証明書設定ファイルの使用（複数証明書対応）
--ssl-client-cert-listSSLクライアント証明書リストのJSONファイルのパスを指定します。例：
ssl-client-cert-list.json--ssl-client-cert、--ssl-client-key、--ssl-client-passphraseオプションよりも優先されます。リスト内のURLに一致するものがない場合、これらのオプションがフォールバックオプションとして使用されます。HTTP/2
--preferred-http-versionパラメータを使用して、リクエストを送信するための特定のプロトコルバージョンを使用するように設定できます。1.
2.
3.
1.
--preferred-http-version="https=HTTP/2,http=HTTP/2-with-prior-knowledge"2.
--preferred-http-version="HTTP/1"3.
--preferred-http-version="HTTP/2"FAQ
Invalid character in header content["Authorization"]というエラーメッセージをどのように処理すればよいですか？