Skip to main content

Creating API Tests in the UI

The platform offers three ways to create API test scenarios through the UI: the Swagger Wizard, Postman Import, and the YAML Editor.

The fastest way to create scenarios. Provide a Swagger/OpenAPI spec and the wizard builds your test steps automatically.

Step 1: Select Source​

  1. Navigate to API Testing in the sidebar
  2. Click Create Scenario
  3. Select a Project and Environment
  4. Choose a target service from the environment (REST_SERVICE targets with a Swagger URL)
  5. Provide the Swagger spec:
    • From URL — paste your Swagger JSON/YAML URL
    • Paste content — paste the raw Swagger JSON or YAML
  6. Optionally override the Base URL
  7. Click Parse & Continue

Step 2: Select Endpoints​

The wizard parses the spec and shows all discovered endpoints:

  • Each row shows the HTTP method (color-coded), path, summary, and parameter count
  • Use the filter bar to search by path, method, or summary
  • Check the endpoints you want to include in the test
  • Use Select All / Deselect All for bulk selection
  • Click Configure Flow (X endpoints)

Step 3: Configure Flow​

Set up the scenario metadata and fine-tune each step:

Scenario metadata:

  • Name (required) — e.g., "User Service CRUD"
  • Description — optional notes

Per-step configuration (each step is an expandable accordion):

  • Step name — auto-generated from the Swagger operation
  • URL path parameters — fill in required path params like {userId}. The wizard highlights these with a warning chip
  • Available variables — shows {{variables}} extracted by previous steps
  • Tabs:
    • Configuration — HTTP method, expected status codes, endpoint path, timeout
    • Headers & Body — custom headers, request body (auto-generated from Swagger schema for POST/PUT/PATCH)
    • Extractions — capture values from responses for use in later steps

Adding an extraction:

  1. Click Add Extraction on the Extractions tab
  2. Fill in:
    • Variable name — referenced as {{variableName}} in later steps
    • Extraction type — JSONPATH, REGEX, or HEADER
    • Expression — e.g., $.id, $.data.token, or a regex pattern
    • Default value — fallback if extraction fails
    • Required toggle — fail the step if extraction fails

Reorder steps using the up/down arrows on each accordion header.

Duplicate a step (icon next to the delete button on each accordion header) — produces a deep-clone of the source step right after it with (copy) appended to the name. Useful when the same endpoint runs twice in a flow with different expected statuses, e.g. a read-after-write step returning 200 and a verify-after-delete step returning 404 on the same GET /users/{{userId}}.

Add custom step — outlined button below the step list, above the Back / Review row. Appends a blank step (method GET, path /, expected status [200]). Expand the step accordion to set the HTTP method (dropdown supports GET / POST / PUT / PATCH / DELETE / HEAD / OPTIONS) and endpoint path (relative to the scenario's baseUrl; wrap variables in {curlies}). The method chip in the accordion summary is read-only — make changes from inside the expanded panel.

Use custom steps for endpoints that aren't in the Swagger spec or for path variations the wizard wouldn't auto-generate. Example full CRUD verification flow:

1. GET    /api/users          → 200
2. POST   /api/users          → 201, extract userId
3. GET    /api/users/{{userId}} → 200   (read after write)
4. DELETE /api/users/{{userId}} → 200
5. GET    /api/users/{{userId}} → 404   (verify deleted — duplicate of step 3, change expected status)

Step 4: Review & Save​

Review the scenario summary: name, endpoint count, environment, and target. Click Save to create the scenario.

Postman Import​

Import existing Postman collections directly:

  1. From the API Testing page, click Import Postman
  2. Upload files:
    • Drop your Postman collection.json (required)
    • Drop your Postman environment.json (optional — maps variables)
  3. Preview & Select:
    • Browse the folder tree of requests
    • Check/uncheck individual requests or folders
  4. Configure:
    • Select target Project and Environment
    • Toggle Group by Folder — creates separate scenarios per folder
    • Toggle Convert Test Scripts — converts Postman pm.test() assertions to platform assertions
    • Toggle Import Variables — maps Postman {{variables}}
  5. Import — created scenarios appear in the list

YAML Editor​

For users who prefer writing tests as code:

  1. From the API Testing page, click YAML Editor
  2. Write or paste your scenario in YAML format:
name: User CRUD Lifecycle
baseUrl: "{{baseUrl}}"
steps:
  - name: Create user
    method: POST
    path: /api/users
    body:
      name: John
      email: john@example.com
    expect: [201]
    extract:
      userId: $.id
  - name: Read user
    method: GET
    path: /api/users/{{userId}}
    expect: [200]
    assert:
      - path: $.name
        equals: John
  1. Click Validate to check syntax
  2. Click Save to create the scenario

See YAML Format for the full reference.

Editing a Scenario​

Click the edit icon on any scenario in the list to open the scenario editor:

  • Form view — edit metadata, steps, auth, headers, and extractions in a structured form
  • YAML view — toggle with the code icon to see/edit the raw YAML representation
  • Test individual steps — click the play icon on any step to execute it in isolation and see the response
  • Quick extraction — after testing a step, click suggested JSONPath chips from the response to auto-create extractions

Configuring Authentication​

In the scenario editor, authentication can come from three sources:

  1. Target auth (recommended) — toggle "Use Target Authentication" to inherit auth from the environment target
  2. Environment auth — use credentials configured on the environment
  3. Custom auth — configure auth directly on the scenario using the auth config editor

The auth config editor supports all 5 types: Bearer (login endpoint), OAuth2 Client Credentials, Static Bearer, Basic Auth, and API Key. Each type has a Test Auth button to verify the configuration works.

Executing a Scenario​

  1. Click the Execute button (play icon) on any scenario
  2. In the execution dialog:
    • Select environment — determines the target URL and credentials
    • Target service — auto-matched by app tag
    • Auth service — select which auth-configured service to use
    • Credential — pick a specific credential tag (or use the default)
    • Run name (optional) — tag this execution for filtering
  3. Click Execute Scenario
  4. Results show in the History tab with per-step pass/fail status

From Test to Load Test​

Any API scenario can be converted to a performance test with one click:

  1. Open a scenario and click the performance icon (or right-click → Convert to Performance Test)
  2. Configure load phases (warm-up, sustained, peak)
  3. Set thresholds (p95 response time, error rate)
  4. Execute — the same endpoints, same auth, now with concurrent virtual users

See From API to Load Test for details.