初めてのAPIテスト – mablヘルプ

mablでは、APIが期待どおりに動作していることを検証するテストを設定できます。APIが正しい形式で期待されるデータを含むレスポンスを返すことを確認するだけでなく、APIテストはチームの全体的なテストワークフローにおいて重要な役割を果たすことができます。たとえば、以下のような場面で活用できます：

初めて使用する場合は、この記事で説明するステップに従って最初のAPIテストを作成し、目標に応じて適切な次のステップを選択してください。

テストを計画する

新しいAPIテストを作成するには、新しいテストをクリックして、APIテストタイプを選択します。テストに名前を付け、CRUDオペレーションやエラー処理など、検証したい内容をプロンプトに記述します。たとえば：

「未認証、禁止、および見つからないリクエストに対して、注文取得エンドポイントが正しいエラーレスポンス（それぞれ401、403、404）を返すことを検証する。」

テストにAPI仕様やAPI説明を追加します：

API仕様：GraphQLやOpenAPIスキーマ、Postmanコレクション、コードファイルなど、APIの仕組みを説明するファイルをJSON、YAML、またはプレーンテキスト形式でアップロードしてください。
API説明：認証手順やサンプルのcURLリクエストとレスポンスなど、アップロードしたファイルに含まれていない情報を追加します。情報は多ければ多いほど効果的です。

テストを作成する前に、コア設定セクションでベースAPIのURLを追加してください。ベースAPIのURLは、リクエストを送信するAPIのルートURLです。たとえば、mabl APIをテストする場合、ベースAPIのURLはhttps://api.mabl.comです。

テストを作成をクリックして、APIテストエディターを起動します。

APIテストエディターが起動すると、mablのAIはテストプロンプトとAPI仕様を使用してテストを生成します。リクエストには変数{{@api.url}}が使用されます。これは、テスト設定を構成したときに追加したベースURLです。

別の内容をお探しの場合は、テストプロンプトを修正して新しいアウトラインを生成をクリックしてください。アウトラインに問題がなければ、テストを作成をクリックして生成されたステップを読み込み、テストの構築を完了します。

APIテストエディターには、右側に生成されたリクエストが表示されます。リクエストをクリックすると、左側にメソッド、URL、ヘッダー、ボディ、およびアサーションが表示されます。認証やアサーションなど、必要に応じて設定を更新してください。

APIに認証が必要な場合は、テストが正しい認証を提供していることを確認してください。すべてのリクエストに同じ認証を適用するには、左上の鉛筆アイコンをクリックしてテストのプロパティを編集します。

特定のリクエストに認証を適用するには、編集者のリクエスト詳細セクションにある認証タブを開きます。

詳細については、APIテストへの認証設定の追加に関する記事をご覧ください。

アサーションは、リクエストが201レスポンスを返すことの確認など、mablが期待される結果を検証する方法です。特定のステップのアサーションを確認するには、編集者でリクエストをクリックし、変数と検証セクションまでスクロールします。

テストが期待どおりに動作することを確認するには、編集者の上部にある再生ボタンをクリックします：

完了したら、テストを保存してAPIテストエディターを閉じてください。

テストを実行するには、テスト実行ボタンをクリックし、次のオプションから選択してください。

クラウド実行（推奨）：mablクラウドからテストを実行し、アプリで詳細なテスト出力を確認します。
ローカル実行: テストをローカルマシンから実行し、出力ウィンドウで結果を確認します。あなたのAPIが公共のインターネットからアクセスできず、mabl Linkを設定していない場合は、このオプションを使用してください。

さまざまなテスト実行環境の詳細については、テスト実行の概要をお読みください。

現在の設定と達成したいことに応じて、次のステップには以下についてもっと学ぶことが含まれるかもしれません。