APIテストは、APIが期待どおりに機能することをすばやく確認できる優れた手段です。mablでは、ブラウザーテストでAPIステップを使用し、APIテストエディターでAPIテストを作成することでAPIをテストできます。
このチュートリアルでは、認証の設定からリクエストの構成、レスポンスの検証まで、APIテストを作成および構成する方法を説明します。
開始する前に
このチュートリアルでは、mabl APIのquery usersエンドポイントの機能を検証するためのAPIテストを作成します。テストを作成する前に、次の情報を収集してください。
- ワークスペースID: [ワークスペース設定] > [ワークスペース]に移動して、ワークスペースIDをコピーします。
- "Viewer" APIキー: [ワークスペース設定] > [API]に移動して、"Viewer" APIキーを作成します。
APIの権限
選択した役割が編集者または閲覧者の場合は、ワークスペースの所有者にAPIキーへのアクセス権限を依頼してください。
新しいテストを作成する
テスト作成 ボタンをクリックし、APIテスト を選択します。テストに名前を付けます。
コア設定で、基本API URLを追加します。
- 「テスト作成に使用するAPI URLを入力してください。」のボックスをチェックします。
- プロトコルを選択してください:
https://
またはhttp://
- ベースAPI URLとして
api.mabl.com
を入力します。
新規APIテストの作成
[作成] ボタンをクリックして、APIテストエディターを起動します。
認証をセットアップする
mabl APIエンドポイントにリクエストを送信する際には、APIキーを提供する必要があります。認証を設定するには、鉛筆アイコンをクリックしてテストプロパティを編集します。
認証の追加
AUTH タブで、「Basic認証」を選択します。「key」をユーザー名として追加し、「閲覧者」mabl API キーをパスワードとして挿入します。
APIリクエスト用の認証の追加
最初のリクエストを設定する
最初のリクエストでは、ユーザーの照会 (Query Users)エンドポイントにGETリクエストを送信します。最初にプラス記号 (+)ボタンをクリックします。
Get UsersエンドポイントのURLはhttps://api.mabl.com/users
です。URL全体を入力する代わりに、mabl変数構文を使用してリクエストを簡素化し、{{@api.url}}/users
にしてください。
{{@api.url}}
{{@api.url}}
はベースAPI URL: https://api.mabl.com
を表します。
PARAMS タブをクリックし、ワークスペースIDをパラメータとして追加します。
リクエストの詳細の追加
リクエストを設定した後、Send ボタンをクリックします。Results セクションでは、レスポンスボディにワークスペースユーザーのリストが表示されるはずです。
レスポンスボディの確認
成功した応答を検証する
デフォルトでは、APIテストエディターはHTTPステータスが200であるというアサーションを作成します。レスポンスがusers
プロパティを返したという別のアサーションを追加します:
- [Validation and variable assignment]セクションで、[Assertions] タブを選択します。
- [Add] ボタンをクリックします。
- 次のJSONパスを入力します。
users
- アサーションのタイプとして "Is present" を選択します。
アサーションの作成
リクエストを再度送信し、[Results] セクションの [Assertions]タブでアサーションの結果を確認します。
アサーションのテスト
変数の作成
レスポンスから変数を作成することもできます。最初のユーザーのメールアドレスを格納する変数を作成してみます。
- [Validation and variables assignment]セクションで、[Variables] タブを選択します。
- [Add] ボタンをクリックします。
- 次のJSONパスを入力します。
users[0].email
- 次の変数名を割り当てます。
email
レスポンスから新しい変数を作成
別のリクエストを追加
このチュートリアルの最後のステップでは、"email"パラメーターを指定してユーザーの照会 (Query Users)エンドポイントにGETリクエストを送信します。
URL {{@api.url}}/users
を入力します。[PARAMS]タブをクリックし、次のパラメーターを追加します。
-
ワークスペース_id
: ここにはワークスペースIDを貼り付けます -
email
:{{@email}}
*
*これはメールアドレス変数の値です。
2番目のリクエストの追加
[Send] をクリックし、[Results]セクションでレスポンスを確認します。
レスポンスの検証
レスポンスを検証するためのアサーションを作成します。
たとえば、次のスクリーンショットのアサーションでは、エンドポイントが1つのユーザーを返し、そのユーザーのメールアドレスがemail
変数の値と一致していることを検証します。
変数に対するアサーション
[Send] を再度クリックし、[Results] の [Assertions]タブを確認して、アサーションに合格したことを検証します。
テスト全体の実行
APIテストエディターで、左上にある再生ボタンをクリックしてテスト全体を実行します。これで、初めてのAPIテストの作成は完了です。🎉
次のステップ
APIテストエディターについて理解したところで、自分のチームのAPIをテストする際にAPIテストエディターをどのように利用できるかを考えてみましょう。次のような点について検討します。
- どのような機能の検証を行う必要があるか?
- この機能を検証するには、どのエンドポイントにリクエストを送信する必要があるか?
- mablでエンドツーエンドのブラウザーテストを強化するには、APIエンドポイントをどのように使用すればよいか?
詳細情報
テストカバレッジを拡大するためのAPIテストの使用方法の詳細については、以下をご覧ください。