API Test Suites

Group multiple API test scenarios into a suite for batch execution. Suites run scenarios sequentially or in parallel and report results at the suite level.

Creating a Suite

POST /api/scenario-groups
{
  "name": "User Service Smoke Tests",
  "description": "Core API validation for User Service",
  "projectId": 2,
  "environmentId": 1,
  "executionMode": "SEQUENTIAL",
  "items": [
    {"scenarioId": 1, "scenarioName": "Health Check", "sortOrder": 1},
    {"scenarioId": 2, "scenarioName": "CRUD Lifecycle", "sortOrder": 2},
    {"scenarioId": 3, "scenarioName": "Auth Validation", "sortOrder": 3}
  ]
}

Execution Modes

Mode	Description	Use Case
SEQUENTIAL	Run scenarios one after another	When scenarios depend on each other
PARALLEL	Run all scenarios simultaneously	Independent scenarios, faster execution

Running a Suite

POST /api/scenario-groups/{id}/execute
{
  "tag": "v2.1-smoke"
}

Response shows results per test case (not per step):

{
  "groupName": "User Service Smoke Tests",
  "executionMode": "SEQUENTIAL",
  "totalScenarios": 3,
  "passed": 2,
  "failed": 1,
  "results": [
    {"scenarioName": "Health Check", "status": "COMPLETED"},
    {"scenarioName": "CRUD Lifecycle", "status": "COMPLETED"},
    {"scenarioName": "Auth Validation", "status": "FAILED"}
  ]
}

Managing Suites in the UI

Navigate to API Tests → Suites tab:

• View all suites with test counts
• Click test chips to open individual test details
• Run Suite button executes all tests
• Delete suites when no longer needed

Suite vs Individual Execution

	Individual	Suite
Reporting	Per scenario	Per suite (scenarios aggregated)
Scoring	Each scenario contributes separately	Suite result contributes as a unit
Use case	Development/debugging	Regression testing, release validation