APIステップ

mablトレーナーでは、APIリクエストを送信し、「APIステップ」でレスポンスを確認することができます。このAPIステップを使うと、UIを操作することなくテストカバレッジを拡大することができます。

📘

ご注意:

この機能は、mablの APIテストの一部です。mabl のすべての Enterpriseプランのお客様とすべてのトライアルユーザー様がご利用いただけます。

APIテストをご購入されるには、こちらからお見積もりをご依頼ください。

このガイドでは、ブラウザテストでAPIステップを作成する基本的な方法を示します。

APIステップエディター

ブラウザテストでAPIリクエストを作成するには、mablトレーナーまたは [クイック編集] モード)でテストを新規作成するかまたは既存のテストを開き、次の手順を実行します。

1. ＋アイコンをクリックして、新しいステップを追加します。
2. [APIリクエスト] を選択します。
3. APIステップエディターでAPIリクエストを設定します。

APIリクエストメソッド

APIリクエストメソッドのドロップダウンをクリックすると、指定したURLに対して実行する具体的なAPIリクエストメソッドを選択できます。

URLフィールド

URLフィールドにAPIエンドポイントを入力します。現在、APIステップは、HTTPまたはHTTPSでアクセスできるAPIをサポートしています。
URLフィールドには、mabl変数の構文 {{@変数名}} を使用した変数も利用できます。たとえば、ベースAPI URLを環境変数として指定してある場合、URLフィールドでは {{@API_URL}} で参照できます。

[SEND] ボタン

このボタンをクリックすると、URLフィールドで指定したエンドポイントに、APIリクエストが送信されます。

APIリクエストの変更

APIリクエスト内のヘッダー、認証方法、ボディーを変更することができます。APIリクエストには、同じく {{@変数名}} の形で表される変数を使用できます。

Headers (ヘッダー)

リクエストヘッダーをキーと値のペアで入力します。

Authorization (認証)

ブラウザテストのAPIステップは、Basic認証とベアラー認証をサポートしています。

Body (ボディー)

リクエストボディを入力します。

APIリクエストの送信

適切なAPIリクエストメソッドを選択して、URLフィールドに入力し、他のオプションを指定した後、[SEND] ボタンをクリックしてリクエストを送信します。

APIレスポンスは、ステータス、ヘッダー、 (該当する場合) レスポンスボディから構成されるJSONオブジェクトとして表示されます。

• headers: キー名と値からを含むHTTPレスポンスヘッダーの配列
• status: HTTPレスポンスのステータス
• body: JSONのレスポンスボディはJSONオブジェクト形式で表示されます。レスポンスボディの他の形式は文字列として表示されます。

結果の使用方法

APIレスポンスからデータを抽出して、アサーションや変数を作成することができます。アサーションや変数はレスポンスの次の値を使用できます。

• Status: HTTPレスポンスのステータス
• Headers: HTTPレスポンスヘッダーの配列。特定のキー名を入力すると、そのキーが持つ値を抽出できます。
• Body (text): レスポンスボディ全体を文字列として抽出します。
• Body (json): ボディをJSONとして解析し、ボディ内の特定のキーの値をJSONパスとして抽出します。

Assertionsタブ

APIステップはすべてのアサーションに成功する必要があります。APIステップのアサーションでは、mabl変数構文を使用して既存の変数を参照できます。

Variablesタブ

[Variables] タブでは、APIレスポンスから変数を作成し、後でテストに使用することができます。

APIレスポンスを使用して変数を作成するようなユースケースとしては、以下のような使い方が考えられます。

• APIレスポンス全体を変数として保存し、後のJavaScriptステップでこの変数を使用する
• レスポンスボディ内の特定のキーの値を保存し、それを以降のステップで使用する。たとえば、APIレスポンスにメールアドレスが含まれている場合、このメールアドレスを抽出して変数email_addressに割り当て、後のテストでこの変数をフォームの入力フィールドに挿入する

Advancedタブ

[Advanced] タブには次の1つのオプションがあります。

• Set response cookies in browser: このオプションを有効にすると、テスト対象ブラウザーに、Set-Cookieレスポンスヘッダーに指定されたcookieが設定されます。

APIステップの保存

[SAVE] ボタンをクリックして、APIステップをテストに追加します。

APIステップの実行は、APIテストの割り当て回数にどのように影響しますか?

クラウド上で実行されるAPIテスト、およびAPIステップの一部として実行されるすべてのリクエストは、ワークスペースに割り当てられている毎月のAPIリクエスト実行回数にカウントされます。

たとえば、5つのAPIステップがあるブラウザテストをクラウド実行した後に、20のAPIステップがあるAPIテストをクラウド実行した場合、送信されたリクエストの総数は25になります。APIテストの使用状況は、ワークスペース設定内のご利用状況ページ ([ワークスペース] > [ご利用状況]) で確認することができます。

ローカル実行の場合、mablトレーナーやAPIテストエディターで実行されたステップを含め、APIテストとブラウザテストのいずれも割り当て回数にはカウントされません。