Assertion

Assertions play a crucial role in API testing, allowing you to verify if the response meets your expectations. Apidog provides a visual interface for creating assertions, making it easy to define test conditions without writing scripts. For advanced scenarios, you can still use custom scripts with full Postman syntax compatibility.

Adding an Assertion

Navigate to Post Processors

Open the Run tab (Design-first Mode) or Request tab (Request-first mode) and scroll to the Post Processors section.

Design-first Mode

Request-first Mode

Add Assertion Processor

Hover over + Add and select Assertion.

Configure Assertion Rule

Select the validation target (e.g., headers, body, status code). Use $ to represent the root object for JSON responses.

Example: To specific checks status field in data object, use $.data.status.

Set Conditions

Define the criteria (e.g., Equals, Contains, Is Null). You can compare against static values or dynamic variables like {{variable}}.

Execute and Verify

Click Send. Results will appear in the Assertion tab of the response panel.

TIP

All data in visual assertions is automatically converted to STRING for comparison. For precise type checking (e.g., distinguishing 4 from 4.0), consider using Custom Scripts instead.

Quick Assertions from Response

You can instantly create assertions based on the actual response data:

Hover over any field in the response body or header.

Click the Assertion button that appears.

Modify the auto-generated rule if needed.

Script-Based Assertions

For advanced validation logic, you can use the pm.test syntax in Custom Scripts. Apidog is fully compatible with Postman scripts.

Learn more about Scripting.

Adding an Assertion#

Quick Assertions from Response#

Script-Based Assertions#

Adding an Assertion

Quick Assertions from Response

Script-Based Assertions