>_ RESTERM
v1.18.2

examples Workflows and mocks

workflows.http

A full workflow with captures, overrides, and expectations.

runs as-is

shell
resterm run --workflow sample-order _examples/workflows.http

Run this from the root of a clone of the Resterm repository.

Editor
# @global base_url https://httpbin.org
# @global workflow.region demo
# @global-secret auth.token seed-token

# @workflow sample-order on-failure=continue environment=demo vars.workflow.name="Sample Order" vars.workflow.item_id="workflow-42"
# @description Demonstrates multi-step workflows with expectations and variable overrides.
# @description Run inside resterm to see per-step status updates and history aggregation.
# @description Share one order reference across steps and make a new one on the next run.
# @tag demo workflow
# @run var order_ref = {{$fake.word}}-{{$randomInt(1000, 9999)}}
# @step Authenticate using=AcquireToken expect.statuscode=200
# @step FetchHeaders using=FetchHeaders expect.status="200 OK" expect.statuscode=200 vars.request.trace_header="workflow-trace"
# @step CreateResource using=CreateResource vars.request.item_value="workflow created" expect.statuscode=200
# @step Cleanup using=DeleteResource on-failure=continue expect.status="200 OK" expect.statuscode=200

### Acquire OAuth-style token
# @name AcquireToken
# @description Simulated token mint using httpbin echo response.
# @tag workflow auth
# @capture global auth.token {{response.json.json.token}}
POST {{base_url}}/post
Content-Type: application/json

{
  "token": "workflow-token",
  "workflow": "{{vars.workflow.name}}",
  "region": "{{workflow.region}}"
}

### Fetch headers with workflow override
# @name FetchHeaders
# @description Demonstrates vars.request.* overrides and captured globals.
# @tag workflow http
# @auth bearer {{auth.token}}
GET {{base_url}}/headers
X-Trace-ID: {{vars.request.trace_header}}
X-Order-Ref: {{order_ref}}

### Create resource using workflow variables
# @name CreateResource
# @description Uses vars.workflow.* and vars.request.* to populate request body.
# @tag workflow http create
# @auth bearer {{auth.token}}
POST {{base_url}}/anything/resource
Content-Type: application/json

{
  "id": "{{vars.workflow.item_id}}",
  "reference": "{{order_ref}}",
  "value": "{{vars.request.item_value}}",
  "workflow": "{{vars.workflow.name}}"
}

### Cleanup resource (simulated)
# @name DeleteResource
# @description Final step shows on-failure handling; httpbin returns 200.
# @tag workflow cleanup
# @auth bearer {{auth.token}}
DELETE {{base_url}}/status/200

_examples/workflows.http on GitHub

Workflows docs
Search

↑↓ moveEnter openEsc close

Help

These keys work like the ones in the TUI.

/
Search the docs (also Ctrl K)
j k
Scroll down and up
g g G
Jump to the top or the bottom
[ ]
Previous and next page
g d
Docs index
g h
Home page
t
Switch between dark and light
?
Show this help
Esc
Close a dialog