Adding an Assertion

For saved endpoints, you can add pre- and post-processors to prepare data or test the endpoint. Assertions are a type of post-processor in Apidog that allow you to validate API responses.

Prerequisites

Before adding assertions, ensure you have:

At least one saved endpoint that you want to add assertions to

Basic understanding of JSON and API response structures

Steps to Add an Assertion

Click on the Post Processors tab.

📷 Visual Reference

Click on Add PostProcessor and select Assertion.

Fill in the Assertion form with the validation details. For example, to assert that the response category id is positive:

Field	Value
Name	"id" is a positive integer
Target Object	Response JSON
JSONPath Expression	`$.category.id`
Assertion Rule	Greater than
Assertion Value	0

JSONPath is a query language for JSON, used to select and extract data from JSON documents. You can click on the 🔨 icon in the JSONPath Expression field to visually extract any JSONPath expression.

Click Send, and you will see the Assertion result in the bottom right corner.

📷 Visual Reference

Click Save to save the changes you made.

In Apidog, you can visually add assertions, extract variables, perform database operations, and more. Learn more about pre and post processors.

You can also write assertions or implement other operations using scripts by simply adding a "Custom script". Apidog is compatible with Postman scripts, which can run in Apidog without modification. Learn more about Scripts.

Next Step

Create a test scenario

Prerequisites#

Steps to Add an Assertion#

Prerequisites

Steps to Add an Assertion