Does recordRequests() track calls across different tests?

No, recordRequests() clears previous recordings when called. Each test starts with a fresh state to ensure isolation and reliability.

How do I verify a specific part of a large API payload?

You can use the toMatchObject() matcher in your test assertions to check specific fields within a recorded request payload without needing to match every single key.

When should I use API request assertions instead of UI checks?

Use request assertions for operations with side effects like POST, PUT, or DELETE to ensure the correct data is sent. For GET requests, it is better to verify the UI displays the data correctly.

Can I use this skill to verify query parameters?

Yes, each recorded request includes a search object containing the parsed query parameters, allowing you to assert that filters or sorting options are correctly passed.

API Request Assertions

Name: API Request Assertions
Author: stacklok

bystacklok

•

セキュリティとテスト

Verifies API request payloads and side effects during automated testing to ensure correct backend interactions.

概要

The API Request Assertions skill provides a standardized framework for verifying that your application sends the correct requests during state-changing operations. It focuses on testing mutations such as POST, PUT, PATCH, and DELETE by capturing outgoing requests via a recordRequests utility. This allows developers to validate JSON payloads, HTTP methods, and URL pathnames, ensuring that form submissions and backend actions behave exactly as expected without the overhead of stateful mock APIs.

主な機能

Captures real-time API requests using the recordRequests utility
81 GitHub stars
Enables batch operation testing by verifying request counts
Validates HTTP methods, pathnames, and parsed JSON payloads
Supports request sequence verification for complex workflows
Integrates with partial matching for flexible payload assertions

ユースケース

Ensuring a delete action targets the specific resource ID in the URL
Validating the execution order of multiple dependent API calls
Verifying that a resource creation form sends the correct data to the backend

概要

主な機能

Captures real-time API requests using the recordRequests utility
81 GitHub stars
Enables batch operation testing by verifying request counts
Validates HTTP methods, pathnames, and parsed JSON payloads
Supports request sequence verification for complex workflows
Integrates with partial matching for flexible payload assertions

ユースケース

Ensuring a delete action targets the specific resource ID in the URL
Validating the execution order of multiple dependent API calls
Verifying that a resource creation form sends the correct data to the backend