ツールキット CLI を使用した API テストの実行

IBM® API Connect デベロッパーズ・ツールキット には、自動化された API 動作テスト用の CLI コマンドが用意されています。

このタスクについて

CLI コマンドを使用して API テストを実行します。
注: テスト目的で API を実行するには、その API をオンラインにする必要があります。 APIをオンラインにし、APIドキュメントを自動発行するには、 Preferences ページの Auto-publish トグルを Onに設定します。 詳しくは、 API のアクティブ化を参照してください。

手順

  1. ツールキットのインストール: API Connect ツールキットのセットアップ
  2. 「端末」を開きます。
  3. YAML ファイルを作成してテストを定義します。 詳しくは、 API 開発および管理のコマンドを参照してください。
  4. 以下の構文を使用して CLI を実行し、テストを実行します。
    apic test yaml-files
    
    ここで、 yaml-files は YAML ファイルの場所を指定します。 例えば、apic test test1.yaml
    • 証明書検査を無効にしてテストを実行するには、 --insecureSkipVerify フラグを使用して CLI を実行します。 これには、以下の構文を使用します。
      apic test yaml-files
       --insecureSkipVerify
      
      ここで、 yaml-files は YAML ファイルの場所です。 例えば、apic test test1.yamlです。
    • CA 証明書がシステムの鍵ストアで使用できない場合は、その場所を --certPath フラグで指定できます。 これを行うには、以下の構文を使用して CLI を実行します。
      apic test yaml-files
       --certPath=location of certs folder
      
      ここで、 yaml-files は YAML ファイルの場所です。 例えば、apic test test1.yamlです。 location of certs folder は、CA 証明書の場所を指定します。
    • mTLS を有効にしてテストを実行するには、 --mtls フラグを使用して CLI を実行します。 これには、以下の構文を使用します。
      api-test test yaml-files
       --mTLS --certPath=location of certs folder
      
      ここで、 yaml-files は YAML ファイルの場所です。 例えば、apic test test1.yamlです。
    • 外部構成を渡すには、 --config-file フラグを使用して CLI を実行します。 これには、以下の構文を使用します。
      api-test test yaml-files
        --config-file=location of config file
      
      ここで、 yaml-files は YAML ファイルの場所です。 例えば、apic test test1.yamlです。 location of config file 構成ファイルの場所を指定します。
    注: 証明書ファイルは、以下の形式で指定する必要があります。
    • tls.crt -公開鍵
    • tls.key-秘密鍵
    • ca.crt-CA 証明書
    テストを YAML ファイルとして定義する方法について詳しくは、 テスト定義の構文を参照してください。

    YAML 構成ファイルでの変数の割り当てについて詳しくは、 YAML 構成での変数の割り当てを参照してください。