生成AIを使用したAPIテストの作成 – mablヘルプ

APIの堅牢なカバレッジを構築するには時間がかかることがあります。テスト作成エージェントを使えば、このプロセスを加速できます。

この記事では、生成AIによるAPIテストの作成方法を説明します。

テスト作成エージェントは、以前は生成AIテスト作成として知られていました。

テストの意図を定義する

新しいAPIテストを作成する際は、自然言語を使用してテストで達成したい内容の説明を追加してください。mablのAIがこの意図を実行するテストステップを生成します。

効果的なテストプロンプトの書き方についてのガイドラインは、こちらをクリックしてください。

テスト用プロンプトの提供

テスト意図を追加すると、テスト作成フォームに新しいAPI仕様セクションが表示されます。このセクションを使用して、テスト対象のAPIに関する情報を追加してください。

APIテストのステップを生成するには、mablがどのAPIエンドポイントとやり取りできるか、またどのようにやり取りするかを知る必要があります。API仕様セクションで、ファイルをアップロードするか、APIの説明を提供してください。

最良の結果を得るには、エンドポイント、対応しているコンテンツタイプ、およびリクエスト／レスポンスオブジェクトの構造を詳しく記載した仕様をアップロードすることをお勧めします。形式としては、OpenAPI仕様（Swagger仕様とも呼ばれます）や GraphQL スキーマなどが例として挙げられます。

単一の標準化されたAPI仕様がない場合は、Postmanコレクション、コードファイル、サンプルリクエストとレスポンスオブジェクト、Chrome DevToolsでキャプチャされたHARログ、またはテキストの説明など、類似の情報を含む他のファイルをアップロードしてみてください。

APIの説明には、アップロードされたファイルに含まれていない情報や、ファイルとしてアップロードするよりもテキストとして記述する方が便利な詳細情報を含めることができます。例えば、認証手順、ヘッダーの要件、テストしたいエンドポイントのサンプルcURLリクエストとレスポンスなどです。

テストの目的を説明し、API仕様を提供した後、テスト作成フォームの残りの情報を記入し、テストを作成をクリックします。

APIテストエディターが起動すると、mablのAIがテストの意図とAPI仕様に基づいてテストを生成します。テスト作成エージェントは、テストの意図に関連する場合、ワークスペースからAPIのフローのインポートを検索します。タスクは、テストの全体的な意図を小さな目標に分解します。

プレビューに満足したら、テストを作成をクリックして、生成されたステップを読み込み、テストを構築してください。

何か違うものをお探しの場合は、テストの意図を変更し、新しいアウトラインを生成をクリックしてください。

テスト内の各ステップを確認し、必要に応じて調整してください。テスト作成エージェントで作成されたステップには、次の内容が含まれます。

インポートしたフローでは、テスト作成エージェントがデフォルトのパラメータ値を使用するか、必要に応じてテストの意図により適合させるためにそれらのデフォルトを上書きできます。

APIテストエディターでステップを実行して、すべてが期待通りに動作するかどうかを検証し、必要に応じて更新してください。

mablは生成AIを使用してAPIテストのステップを生成しますが、提供された情報に制限されます。APIに関する情報が不十分である場合や、スキーマがmablと連携するには複雑すぎる場合、生成されたステップに誤りがある可能性があります。
生成されたAPIテストのステップにはスニペットが含まれていないため、より複雑な検証やリクエスト前処理用およびリクエスト後処理用スクリプトは作成されません。
OAuth 1.0およびOAuth 2.0の認証タイプは生成されません。これらの方法のいずれかを使用してAPIに認証したい場合は、テストを生成し、テストレベルで認証設定を手動で追加してください。
テスト作成エージェントは英語に偏っています。テストの意図を英語以外の言語で定義した場合でも、APIテストエディターはタスクやアサーションを英語で生成することがあります。