ReadyAPI で SmartBear AI を使ってテストを生成する方法

SmartBear AI は、ReadyAPI に AI アシスト機能を提供します。これにより、自然言語入力を使用して API テストの生成、レビュー、最適化が可能になります。

ReadyAPI AI は、自然言語による指示に基づいて API 定義からテストケースを生成します。API 定義をインポートし、テストシナリオを説明し、レスポンスプロファイルを選択し、必要なアサーションタイプを指定するだけで、わずか数秒で完全なテストケースを生成できます。生成されたテストケースは、そのままレビューや編集、実行が可能です。

ベータ版に関する注意事項:
この機能はベータ版として提供されており、今後も継続的に改善されます。エラーが発生した場合や、期待通りの結果が得られなかった場合など、皆様からのフィードバックやユースケースをお待ちしております。

注:
このベータ版の利用には、SLM クラウド環境でホストされているライセンスが必要です。オンプレミスの SLM ライセンスへの対応は、今後のリリースおよび一般提供 (GA) 時に予定されています。

AI 機能を有効する前に、SmartBear の AI 機能利用規約を必ずご確認ください。

ReadyAPI における AI の仕組み
アプリケーションレベルでの制御
1. ReadyAPI で SmartBear AI を有効/無効にする
  1. ReadyAPI UI から SmartBear AI を制御する
  2. マネージドデプロイメントでの SmartBear AI の制御
SLM レベルでの制御
ReadyAPI で SmartBear AI を使用する

ReadyAPI における AI の仕組み

SmartBear AI は、基盤となる大規模言語モデル (LLM) を活用しています。SmartBear は、お客様のデータを使用して AI モデルのトレーニングを行うことはありません。

アプリケーションレベルでの制御

ReadyAPI で SmartBear AI を有効/無効にする

ReadyAPI では、SmartBear AI 機能はデフォルトで無効に設定されています。

ReadyAPI UI から SmartBear AI を制御する

SmartBear AI 機能を有効にするには、次の手順に従ってください。

ReadyAPI を開きます。
ツールバーで[Preferences] を選択します。
左側のペインで [Integrations] に移動しし、[SmartBear AI] を選択します。
[Enable SmartBear AI integration] を選択します。
[OK] を選択します。
SmartBear AI を有効にすると、ナビゲーションバーの [Open SmartBear AI] ボタンがアクティブになります。このボタンを使用して、[Generate Tests with SmartBear AI] ダイアログを開きます。SmartBear AI が無効な状態では、このボタンは操作できません。

マネージドデプロイメントでの SmartBear AI の制御

ReadyAPI をマネージドイメージとして展開している組織では、JVM オプションを使用して AI 機能の可用性を制御できます。この設定を行うと、起動時に AI 機能が無効化され、UI から AI 関連のオプションが非表示になります。

次の JVM オプションを使用してください: -Dreadyapi.enable.ai.features=<value>
すべての AI 機能をオフにするには、値を次のように設定します: -Dreadyapi.enable.ai.features=false

SLM レベルでの制御

SmartBear License Management (SLM) を通じて、組織全体の SmartBear AI へのアクセスを制御できます。SLM ではデフォルトで AI が有効になっていますが、組織単位で無効にすることも可能です。

組織内のすべての SLM ユーザーに対して AI 機能を無効にするには、以下の情報を添えて SmartBear サポートにリクエストを送信してください。

Issue Type: Other
A short accurate description of your query (Subject): Request to Disable SmartBear AI for SLM organization
Problem description: 正確な SLM 組織名を含めてください。

SLM レベルで AI を無効にすると、その組織のすべてのユーザーが ReadyAPI の AI 機能にアクセスできなくなります。

ReadyAPI で SmartBear AI を使用する

SmartBear AI を有効にすると、自然言語のプロンプトを使用して API 定義から機能テストケースを直接生成できるようになります。SmartBear AI は、入力に基づいてテストステップとアサーションを作成し、生成されたテストケースを ReadyAPI Project Workspace に追加します。

SmartBear AI を使用したテストケース作成手順

API 定義をインポートします。
自然言語でテストシナリオを入力します。
レスポンスプロファイルを選択します (Performance または Accuracy)。
生成されたテストケースに含めるアサーションを選択します。
[Generate Test Case] をクリックしてテストを作成します。
検証エラーが発生した場合は確認して解決します。
生成されたテストケースを確認します。
フィードバックを送信または問題を報告します。

ステップ 6〜8 は、テストケース生成後に推奨されるフォローアップアクションです。

API 定義のインポート

ローカルファイル、または Swagger Studio 連携を通じて API 定義をインポートします。インポートが完了すると、テスト生成に使用できるオペレーションやスキーマが ReadyAPI 上に表示されます。

テストシナリオの入力

テストシナリオを自然言語で入力します。ReadyAPI はこの説明を基に、生成されるテストケースに含まれるリクエストフロー、データ、およびアサーションを構成します。

シナリオの入力例

例 1: Create a test that creates a pet, updates it, and deletes it. (ペットを登録し、更新し、削除するテストを作成します。)
例 2: After logging in, purchase a pet, verify the stock shows the pet is sold, and log out. (ログイン後、ペットを購入し、在庫状況が「販売済み」になっていることを確認してログアウトします。)
例 3: Log in, create a pet named “Fido”, sell “Fido,” update the status to “sold”, verify the pet status is sold, and log out. (ログインし、「Fido」という名前のペットを登録します。その後「Fido」を販売してステータスを「sold」に更新し、正しく更新されたことを確認してからログアウトします。)

レスポンスプロファイルの選択

SmartBear AI が速度と分析のバランスをどのように取るかを選択します。

Performance: 軽量な処理で素早く結果を生成します。迅速な反復処理や日常的なテスト生成シナリオに適しています。
Accuracy: より詳細で綿密に分析されたテストシナリオを生成します。このプロファイルは処理にやや時間がかかりますが、より正確で包括的な結果が得られます。

アサーションタイプの選択

SmartBear AI が生成するテストケースに含めるアサーションタイプを選択します。

Validate HTTP Response Status: テストステップが API 定義で指定された HTTP ステータスコードを正しく受信するかをチェックします。
Validate Swagger/OpenAPI Compliance: レスポンスが API 定義の内容と一致しているかを検証します。
このアサーションは以下の仕様をサポートしています。
- Swagger 2.0 (OpenAPI 2.0)
- OpenAPI 3.0.0
- OpenAPI 3.1.0
Validate Response SLA: レスポンスが規定の時間内に返ってくるかをチェックします。

テストケースの生成

すべての入力を完了したら、ワンクリックでテストケースを生成できます。SmartBear AI は、入力された説明とインポートした API 定義に基づいて、テストステップとアサーションを自動的に作成します。

生成されたテストケースは、Project Workspace の Functional Tests に自動的に追加されます。ReadyAPI は「Project X」(X は次に使用可能なプロジェクト番号) という新しいプロジェクトを作成します。プロジェクト内には、「AI-Generated Test Suite 1」が作成され、その中に生成されたテストケースが含まれます。

生成されたテストケースは、ReadyAPI の UI 上で確認・編集が可能です。また、それぞれのテストワークフローに合わせて、GUI、TestRunner、または TestEngine を使用して実行することができます。

検証エラーの確認と解決

SmartBear AI は、インポートされた API 定義と入力されたプロンプトを基にテストケースを生成します。ReadyAPI は AI のレスポンスを解析し、生成されたテストケースを Project Workspace Navigator に追加して確認できるようにします。

場合によっては、このプロセス中に検証エラーや解析エラーのメッセージが表示されることがあります。これらのメッセージは通常、フォーマットの不一致や SmartBear AI と ReadyAPI 間での不完全なデータ受け渡しなど、AI が生成したレスポンスの解析における問題を示しています。以下はその一例です。