Examples

Use request definitions and auth config as project assets.

The generated .apifire structure is the strongest proof that the workflow is file-first. Review the scaffolded YAML and use it as the baseline for your own suite.

Scaffold preview

These files sit at the center of the workflow.

Generated file

.apifire/config.yaml

Project-level defaults like API base URL, timeout, and shared headers.

.apifire/config.yaml

name: demo
base_url: https://api.example.com
timeout: 30
headers:
  Content-Type: application/json
  User-Agent: apifire/1.0

Generated file

.apifire/auth.yaml

type: bearer_token
login:
  endpoint: /auth/login
  method: POST
  body:
    username: "{{env.USERNAME}}"
    password: "{{env.PASSWORD}}"
  token_path: "data.token"

Generated file

.apifire/requests/example.yaml

Request asset checked into the repo with validation expectations.

.apifire/requests/example.yaml

name: Example Request
method: GET
endpoint: /health
auth: skip
validate:
  status: 200