アサーション
APIチェックのアサーション
アサーションとは？
アサーションは、APIリクエストのステータスコードとレスポンスタイムを検証するために設定する条件です。さまざまな条件下でAPIが期待通りに動作することを確認するのに役立ちます。1つ以上のアサーションが失敗すると、アラートがトリガーされ、即座にアクションを実行できます。
アサーションの種類
APIチェックに対して、以下の種類のアサーションを設定できます：
- レスポンスタイム：値を設定し、その値と比較してチェックします。レスポンスタイムが指定した値を超えると、アサーションが失敗し、テストが失敗します。
- ステータスコード：APIレスポンスの期待されるステータスコードを指定します。レスポンスコードが期待値と異なる場合、アサーションが失敗し、APIチェックが失敗します。
失敗したアサーションとチェックの詳細
アサーションが失敗すると、失敗の詳細がチェック詳細ページに表示されます。これには、どのアサーションが失敗したか、その理由に関する情報が含まれ、問題を迅速に特定して解決するのに役立ちます。
レスポンス制限との相互作用
チェックにレスポンスタイム制限があり劣化としてマークされているが、失敗したアサーションもある場合、チェックは失敗としてマークされます。これにより、すべての重要な問題が確実にキャプチャされ、迅速に対処されます。
アサーションの設定方法
- アサーション設定にアクセス：APIチェックのアサーション設定に移動します。
- アサーションを追加：追加したいアサーションの種類（レスポンスタイム、ステータスコード）を指定します。
- 基準を設定：アサーションの基準を定義します（例：期待されるステータスコード、最大レスポンスタイム）。
- 設定を保存：アサーションを適用するために、設定を保存してください。
実用的なユースケース
- パフォーマンスモニタリング：レスポンスタイムアサーションを使用して、APIがパフォーマンスベンチマークを満たしていることを確認します。
- エラー検出：ステータスコードアサーションを使用して、APIの予期しないエラーや障害を検出します。
アサーションを使用することで、APIが期待通りに動作し、正確なデータを提供していることを確認でき、サービスの信頼性とパフォーマンスの維持に役立ちます。