API Test

Runs Tavern YAML API tests against your service. The HOST environment variable is automatically set to the base URL of the target service.

Fields

Field	Type	Required	Constraints	Description
file	string	Yes		Path to the Tavern YAML file, relative to repo root
cpuCores	float	No	0 < value ≤ 2
memoryMB	integer	No	≤ 4096
targetName	string	No		Name of the service to test. Defaults to the first service
env	table	No		Environment variables injected into the test runner. HOST is set automatically

[apitest]
file = ".nurburgdev/apitest.tavern.yaml"

Example Tavern file

test_name: Get items returns 200
includes:
  - !include common.yaml
stages:
  - name: Get items
    request:
      url: "{host}/api/items"
      method: GET
    response:
      status_code: 200

Telemetry metrics

Name	Description
SUMMARY	Percentage of test cases that passed
REPORT	Per-test case results