APIテストの作成

mablでAPIテストを作成する方法

このガイドでは、mablワークスペースでベースAPI URLを設定し、新規APIテストを作成する方法について説明します。

📘

Enterprise機能

APIテストは、トライアルユーザーとEnterpriseサブスクリプションプランのお客様が使用できます。

環境の設定

mablワークスペースにAPI URLがすでに追加されている場合は、「新規APIテストの作成」セクションに進んでください。追加されていない場合は、次の手順で、mablワークスペースでAPIのベースURLをアプリケーションに追加する必要があります。

  1. [Configuration] > [Applications] に移動します。

  2. 特定のアプリケーション/環境のURLをクリックします。編集モーダルが表示されます。

  3. [Add URL] をクリックします。

  4. タイプで [API] を選択し、ベースURLを入力します。

👍

末尾のスラッシュは省く

アプリケーション/環境にベースAPI URLを追加する際は、URLの末尾のスラッシュを省いてください。たとえば、https://example.com/ではなく、https://example.comと記述します。

末尾のスラッシュを省くことで、APIテストエディターでリクエストを扱う際に、{{@api.url}}usersではなく、{{@api.url}}/usersと記述できるため可読性が向上します。

adding an api url

mablアプリケーション/環境へのAPI URLの追加

  1. [Save]をクリックして変更内容を保存します。この更新により、このアプリケーション/環境に対してapi.urlという変数が作成されます。

ベースAPI URLの追加が済んだら、mablで最初のAPIテストを新規に作成したり、既存のPostmanコレクションをインポートしたりすることができます。

新規APIテストの作成

新規APIテストを作成するには、次の手順を実行します。

  1. 左側のナビゲーションの [New test] ボタンをクリックします。

  2. テストタイプとして [API test] を選択します。新規APIテストの作成フォームが表示されます。

new api test

新規APIテストの作成

少なくとも、テスト名とテスト対象APIを定義する必要があります。

APIテストに適用可能なすべての設定の一覧を以下に示します。

基本設定 (The basics)

  • テスト名 (Test name): ワークスペースの他のメンバーと相談して、命名規則を決めておくことをお勧めします。それにより、テストの探索が容易になり、テストの内容を理解しやすくなります。

  • 説明 (Description): テストに関する詳細なコンテキストや説明を追加するのに使用します。

  • テストラベル (Test labels): mabl CLIで並べ替えやアドホック実行を開始するときに使用できます。

プランに追加 (Add to plan)

テストを既存のプランに追加することも、新規プランを作成することもできます。また、テストをプランに追加しないこともできます。

  • 既存プラン (Existing plan): ドロップダウンからプランを選択します。既存のプランに対して設定されているアプリケーション環境がテストに使用されます。

  • 新規プラン (New plan): プラン名を入力し、プランを実行するアプリケーションと環境を選択します。

  • プランなし (No plan): テストのアプリケーションと環境を選択します。

📘

API URLが必要

ベースAPI URLのないプランやアプリケーションには、APIテストを追加できません。アプリケーションにAPI URLを追加するには、「環境の設定」セクションを参照してください。

詳細オプションを表示する

DataTableをAPIテストに関連付けることができます。DataTableを使ってAPIテストをトレーニングする場合は、こちらに記載された手順に従ってください。

🚧

テストのサイズ制限

APIテストのサイズは、1MBを超えることはできません。サイズの大きなJavaScriptスクリプトの使用には注意が必要です。

ブラウザーテスト作成フォームへの入力が済んだら、[Create test]をクリックしてAPIテストエディターを開き、ステップを追加します。

詳細はこちら