Executable GraphQL specifications
A GraphQL specification keeps an operation, variables, request metadata, expected errors, schema behavior, and response data-path assertions in one executable contract.
What you can do
- Define query or mutation text, operation name, variables, headers, and multipart uploads.
- Validate GraphQL errors, response schema behavior, selected data paths, and document evidence exposed through configured response fields.
- Run the contract independently or reuse it as a step in a mixed flow.
Starts with
- A GraphQL endpoint, operation document, variables, and optional uploaded files.
- Expected errors, data paths, types, and response attachment evidence.
Produces
- A runnable GraphQL specification with structured operation evidence.
- Document assertion evidence without persisting decoded response document bytes.
- A reusable GraphQL step for flows, monitoring, snapshots, and ATF exports.
Use it when
- Use GraphQL specs when a test must validate operation-level data instead of only HTTP status.
- Assert meaningful data paths and declared errors while allowing unrelated fields to evolve.
- GraphQL specification
- GraphQL variables
- data-path assertions
- GraphQL errors