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

CLIツールの使用

echoapi-cli echoapi-cliは、EchoAPIインターフェースケースおよびテストケースを実行するために設計されたコマンドラインツールです。これにより、コマンドラインから直接これらのケースを簡単に実行およびテストできます。

スケーラビリティを考慮して構築されており、継続的インテグレーションサーバーやビルドシステムとの統合が容易です。これにより、手動介入なしでEchoAPIインターフェースケースのテストと実行の自動化が可能になります。

このモジュールは現在オープンソースです。

Github: https://github.com/EchoAPI-Team/echoapi-cli

NPM: https://www.npmjs.com/package/echoapi-cli?activeTab=readme

インストール​

// Start of Selection 次のコマンドを使用してEchoAPI CLIをインストールします：

npm install -g echoapi-cli
tip

echoapi-cliの古いバージョンがインストールされている場合は、まずアンインストールしてください。インストールされているnpmパッケージのリストを表示するには：npm list -g --depth=0。アンインストールコマンド：npm uninstall -g echoapi-cli。

Running​

echoapi run "https://app.echoapi.com/open/ci/automated_testing?ci_id=MTkzMDI0MTEwMDU2ODQ5NDA4OjEyOTMzMDc1MDgzNjc3NzEwOjEzMDcyNjE0MDg3OTQ2Mjcy\u0026token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxODE0NCwiaXNzIjoiYXBpcG9zdCIsImV4cCI6MTcxNzY5MDAxNX0.wNNw0MbsbobhDcAZmiXJQu6lmhWaES6E2y8YFyKkzm8" -n 5 -r cli,json

img_v3_02dj_b20432c1-f071-42a0-b8de-4bd887df33dg.jpg

Options​

Usage: echoapi run [options] <url>
Options:
  -r, --reporters            テストレポートのタイプを指定します。cli、html、jsonをサポートします（デフォルト："cli"）
  -n, --iteration-count      イテレーションの回数を設定します。デフォルト値は1です
  -d, --iteration-data       ケースのイテレーション用の[public]テストデータのパスを設定します（JSONまたはCSV）。設定されている場合、デフォルトの[public]テストデータが置き換えられます。
  --external-program-path    [外部プログラム]のファイルパスを指定します。デフォルトはコマンドの現在の実行ディレクトリです
  --out-dir                  テストレポートディレクトリを出力します。デフォルトディレクトリは：/Users/mhw/echoapi-reports
  --out-file                 テストレポートファイル名を出力します。接尾辞を追加する必要はありません。デフォルトの形式はechoapi-reports-current YYYY-MM-DD HH:mm:ssです
  --ignore-redirects <0/1>   3XXステータスコードを返すリクエストの自動リダイレクトをEchoAPIが防止します。0は防止、1は防止しない（デフォルト："0"）
  --max-request-loop         3XXリダイレクトの最大リダイレクト数（デフォルト：5）
  --timeout-request          インターフェースリクエストのタイムアウトを指定します（デフォルト：0）
  --timeout-script           プリエクスキューション/ポストエクスキューションスクリプトのタイムアウトを指定します（デフォルト：5000）
  --delay-request            リクエスト間のインターバルを指定します（デフォルト：0）
  -k --insecure              SSL検証を無効にします（無効にするには1、有効にするには0。デフォルト：1）（デフォルト：1）
  --ssl-client-cert-list     クライアント証明書構成ファイルへのパス（JSON）を指定します。このオプションはsslClientCert、sslClientKey、およびsslClientPassphraseより優先されます。
  --ssl-client-cert          クライアント証明書のパスを指定します（CRTファイル）
  --ssl-client-pfx           クライアント証明書のパスを指定します（PFXファイル）
  --ssl-client-key           クライアント証明書の秘密鍵パスを指定します（KEYファイル）
  --ssl-client-passphrase    クライアント証明書のパスワードを指定します（保護されたキー用）
  --ssl-extra-ca-certs       追加の信頼されるCA証明書を指定します（PEM）
  --web-hook                 タスクが完了した後、JSONレポートデータを指定されたURL（POST）に送信するWebフック
  -h, --help                 コマンドのヘルプを表示します

Example of Client Certificate Configuration File (JSON)​

{
    "https://wwww.example.com:443": {
        "pfx": {
            "file_url": ""
        },
        "crt": {
            "file_url": ""
        },
        "key": {
            "file_url": ""
        },
        "password": ""
    },
    "https://*.echoapi.com:443": {
        "key": {
            "file_url": ""
        },
        "pfx": {
            "file_url": ""
        },
        "crt": {
            "file_url": ""
        },
        "password": ""
    }
}

バージョンのアップグレード​

EchoAPI CLI ツールをアップグレードするには、次のコマンドを使用してください：

npm install echoapi-cli@latest -g