Executable REST specifications
A REST specification is an executable HTTP contract that combines one request with the status, headers, payload fields, filtering rules, attachments, and cases expected from its response.
What you can do
- Define method, URL, authentication, headers, parameters, body, and request attachments.
- Assert status, content type, headers, body paths, excluded fields, and response documents by hash or, where supported, structural fingerprint.
- Run, inspect, regenerate, batch, or assemble specifications from reusable fragments.
Starts with
- A REST endpoint and the request data needed to exercise its behavior.
- Expected response evidence, entered manually or generated from Craftsman or OpenAPI TestGen.
Produces
- A saved REST specification and structured run evidence.
- Document assertion evidence without persisting the returned document bytes.
- A reusable API step for flows, Sentinel checks, snapshots, and ATF exports.
Use it when
- Use REST specs for repeatable endpoint checks and release regression coverage.
- Use parameterized cases when the same behavior should be exercised with several inputs.
- REST specification
- HTTP assertions
- parameterized cases
- attachment assertions