APIテストを作成する際には、個々のAPIリクエストのレスポンスにアサーションを追加して、APIが期待どおりの結果を返していることを検証することが重要です。たとえば、リクエストのステータスコードが201に等しいかどうかや、レスポンスボディ (JSON) に特定のメールアドレスを持つユーザーが含まれているかどうかをアサートします。この記事では、APIテストエディターのアサーションオプションについて説明します。
[バリデーションと変数代入] セクションでのアサーションの作成
コードなしでのアサーションの作成
アサーションを作成するには、[バリデーションと変数代入] セクションの [アサーション] タブをクリックします。APIレスポンスを初めて検証する場合は、APIアサーションのベストプラクティスに関する記事を参照してください。
デフォルトステータスのアサーション
デフォルトでは、テスト内に新しいAPIステップを作成すると、ステータスコードが200に等しいかどうかを確認するアサーションが自動的に作成されます。このアサーションは必要に応じて編集または削除できます。
アサーションターゲット
APIテストエディターは、次のアサーションターゲットをサポートしています。
| アサーションターゲット | 説明 |
| ヘッダー | ヘッダーキーの値 |
| ステータス | APIレスポンスのHTTPステータスコード |
| サイズ | APIレスポンスのサイズ (バイト単位) |
| JSONボディ | JSONパス言語を使用して、ターゲットとなるレスポンスプロパティを指定 |
アサーションタイプ
APIテストエディターは、次のタイプのアサーションをサポートしています。
- Equals (次の値に等しい)*
- Does not equal (次の値に等しくない)*
- Contains (次の値を含む)*
- Is present (存在する)
- Not present (存在しない)
- Greater than (次の値より大きい)
- Greater than or equal to (次の値以上)
- Less than (次の値より小さい)
- Less than or equal to (次の値以下)
- Starts with (次の値で始まる)*
- Ends with (次の値で終わる)*
- Matches regular expression (次の正規表現に一致)
* 大文字小文字を区別しない設定が可能
スクリプトによるレスポンスの検証
より複雑な検証シナリオを処理しなければならない場合や、XMLレスポンスボディを返すSOAPベースのAPIを検証する場合は、APIスクリプトの例の説明に従ってJavaScriptコードを使用できます。