アプリの API 呼び出しを API テストにするにはどうすればよいですか?
アプリを使いながら呼び出しを記録し、一覧を確認して、残した呼び出しからテストを生成します。Verdict System LLC の Nexus StudioQA に搭載された Nexus Recorder は、ページが行う呼び出しを REST または GraphQL のテストとして記録し、認証ヘッダーと Cookie ヘッダーを除外して、機密情報らしいフィールドを環境変数に置き換えます。すべて手元のマシンで実行されます。
最終更新日:
執筆: Verdict System LLCのNexus StudioQAチーム。
記録はどのように行われますか?
- Nexus Recorder で、ログインや購入手続きなどの操作を進めながら、ページが行う呼び出しを記録します。
- テストを書き出す前に、確認画面で各呼び出しのメソッド、パス、ステータス、分類と、採用または除外の理由が一覧表示されます。
- 業務処理、認証、読み取り、状態変更の呼び出しは、最初からテスト群に含まれます。計測用ビーコン、第三者のホスト、静的ファイル、プリフライトは除外されますが、チェックを入れればどれでも追加できます。
- フローでは、ログインで返されるトークンなど、ある応答の値を後続のリクエストに引き継ぎます。
記録から何を生成できますか?
- テストを生成で API テスト群を書き出します。
- OpenAPI を生成で、型とステータスコードを含み、記録した値は含まない OpenAPI 3.1 の草案を書き出します。
- 負荷テストで、同じ呼び出しを負荷試験計画として開きます。
テストファイルから何が除外されますか?
| 記録時に取得したもの | テストファイルに入るもの |
|---|---|
| 認証ヘッダーと Cookie ヘッダー | 除外 |
| 機密情報らしい名前のフィールド | 環境変数に置き換え、秘匿処理の一覧に表示 |
| 任意のフィールドに含まれる JWT、プロバイダーのキー、カード番号 | フィールド名だけでなく、値に基づいて秘匿処理 |
| 計測データ、第三者のホスト、静的ファイル、プリフライト | 初期設定で除外 |
テスト実行時、認証トークンは API_BASE_URL のオリジンにのみ送信され、記録に含まれる別のホストには決して送信されません。
API テストはどのように判定されますか?
ほかのテストと同じように Patrol から実行され、エンドポイントごとに専用の証拠フォルダーが作成されます。API テストにはサンドボックスがなく、初回の実行操作から実際に動作します。API 専用の判定があり、すべての検証条件を満たし、応答の構造が前回の記録と一致すれば API_SECURE、再試行で成功すれば API_FLAKY、成功しても構造が変わっていれば API_DRIFTED となり、追加、削除、型変更があった各フィールドの名前が示されます。API スキーマの変化では、実際の実行で生じた変化を紹介しています。
制限事項には何がありますか?
- 記録に含まれるのは、記録中にページが行った呼び出しだけです。その操作の流れで使わなかったエンドポイントは含まれません。
- 記録からは REST と GraphQL のテストを書き出せます。SOAP テストは、XML をテキストとして送信し、テキスト用のルールで検証する形で手動作成します。
- API テストは Studio 独自の形式を使うため、別の実行環境に移すには書き直しが必要です。Recorder が書き出すブラウザーテストは、標準の Playwright または Selenium のままです。
- 生成されたテストを信頼する前に、内容を確認してください: 記録が把握しているのはアプリが実際にしたことであり、本来すべきことではありません。
どこで確認できますか?
Studio の紹介では Nexus Recorder を紹介し、API スキーマの変化では実行可能な例で API の判定を説明しています。無料体験版では、同じエンジンをお使いのアプリで実行できます。