API Testing & Test Suites

The Test Suite feature lets you group HTTP requests into named suites, define assertions on each response, and run them all with a single click. It is available as a Pro feature.

To open the Test Suite window:

1. Open any OpenAPI specification in SuagerUI.
2. Click the Test Suite button in the document header bar (next to Mock Server and Export).
3. The API Testing window opens pre-loaded with your spec, so you can add endpoints directly from it.

A Test Suite is a named group of test cases that run sequentially. You can create as many suites as you need — for example, one per feature area, one for smoke tests, one for full regression.

1. Click the + button in the suite list sidebar.
2. A new suite named “New Test Suite” is created.
3. Click the suite name in the detail header to rename it.

To delete a suite, right-click it in the sidebar and choose Delete.

There are three ways to add test cases to a suite:

Manual

Click Add Test in the test case list header. This creates a blank test case where you configure the method, path, base URL, headers, body, and authentication manually.

From your spec (single endpoint)

When a spec is loaded, the Batch Add menu lets you pick individual tags. All endpoints within that tag are added with pre-filled method, path, base URL, and a default status code assertion.

Batch add all endpoints

Choose Add all endpoints at the bottom of the Batch Add menu to add every endpoint in your spec at once. Each gets contract testing enabled by default.

Assertions define what you expect from the API response. If any enabled assertion fails, the test case is marked as failed.

When you add a test case from the spec, a status code assertion is automatically added based on the first response defined in the spec.

Variables let you parameterize your test cases. Use the {{variableName}} syntax in any field: path, base URL, headers, body, query parameters, and authentication values.

Variables follow a hierarchical override system with three scopes:

When the same variable name exists at multiple scopes, the narrower scope wins: Request > Suite > Global.

Base URL: {{baseUrl}}
Path:     /users/{{userId}}
Header:   Authorization: Bearer {{token}}

Request chaining lets you extract values from one response and use them in subsequent test cases. This is essential for flows like:

1. POST /users → extract id from the response
2. GET /users/{{userId}} → use the extracted ID
3. DELETE /users/{{userId}} → clean up

Setting up extraction

Each test case has an extractAfter configuration where you define:

• Variable name — the name to store the extracted value under (e.g., userId)
• JSON path — a dot-separated path to the value in the response body (e.g., data.id)

Extracted values are available as {{variableName}} in all subsequent test cases within the same run.

Contract testing validates that the live API response matches what your OpenAPI spec promises. When enabled on a test case, SuagerUI checks:

• The response status code is defined in the spec
• The response body JSON types match the schema (string, integer, number, boolean, array, object)
• Object structure matches the defined properties

Contract violations are shown separately from assertion failures, marked with a purple badge. A test case fails if it has any contract violation or assertion failure.

Click the green Run All button in the suite detail header to start execution. Tests run sequentially with the configured delay between requests.

During execution you will see:

• A progress bar showing the current test number
• Live pass/fail counts updating in real time
• Each completed test appearing with its status, HTTP code, and duration

Click Cancel to stop the run at any time. Results collected so far are preserved.

After the run completes, switch to the Results tab for the full breakdown. Failed assertions show the expected vs. actual values. Contract violations list the specific schema mismatches.

Export your test results for CI integration or reporting. Click the export icon next to the Run All button and choose a format:

Both formats include the suite name, timestamps, duration per test, assertion details, and contract violations.

Set up recurring test runs to continuously monitor your API. Go to the Schedule tab in the suite detail view:

1. Enable the toggle for scheduled runs.
2. Set the interval in minutes (default: 30 minutes).
3. The suite will automatically run at the specified interval.

When a scheduled run completes with failures, SuagerUI sends a desktop notification with the suite name and pass/fail counts. All scheduled runs appear in the run history at the bottom of the Schedule tab.