API Contract Testing: Identify consumer compatibility and migration risk from API changes
A server can pass its own tests after making a field optional while a consumer fails in production. Contract testing protects the boundary both sides believe they share.
The API Contract Testing Skill derives examples from consumer expectations and catches incompatible changes before separate deployments make the disagreement costly.
This guide organizes the practice around clear inputs, boundaries, and outputs, so the next person can act on the conclusion with confidence.
API Contract Testing Skill: what it is for
API Contract Testing is for work that needs a clear, handoff-ready testing judgment. It keeps project material, the basis for each decision, and the next action on the same trail—so a reader can see what to inspect before choosing how to execute and review it. This guide works through one concrete scenario and keeps human decision boundaries visible.
Start with the source Skill
The complete execution contract lives in API Contract Testing prompt. The source directory also contains 3 evaluation cases for checking whether an output follows the contract.
The entry point calls out these constraints:
- contracts include semantics and error behavior, not only schemas
- do not infer full contracts from examples
- breaking changes require a migration path
Begin with project facts
Put the material you have on the table. Gaps may remain; their status needs to stay explicit.
| Material | What to provide | What to do when it is missing |
|---|---|---|
| Goal and scope | Review a new order API version for fields, error bodies, status codes, consumer impact, and migration path | Name journeys outside this pass |
| Version and environment | Requirement version, build, environment, time window | Stay in design or analysis mode |
| Evidence | Requirements, interfaces, logs, metrics, traces, or defects | Separate facts, assumptions, and open questions |
| Decision boundary | Risk approver and actions that are not authorized | Name the owner and next step |
Use a request like this:
Use the api-contract-testing Skill.
Task: Review a new order API version for fields, error bodies, status codes, consumer impact, and migration path
Inputs: [versions, links, log paths, or reports]
Scope: [included and excluded objects]
Constraints: [time, data, permissions, compliance]
Audit the inputs first. Order results by risk and evidence strength. Label unsupported claims as assumptions and give a validation method.Make the result usable by the next person
| Output field | Why it exists | Example status |
|---|---|---|
| Finding or judgment | Describes observed behavior, difference, or risk | Confirmed / Assumption / Open |
| Basis | Points to a version, log, trace, test, or requirement | source_id or link |
| Impact | Explains affected users, journeys, or release decision | P0, P1, or accepted residual risk |
| Next action | Names verification work and an owner | Owner, date, expected evidence |
Do not write “passed” without a run record, query result, or source artifact. Static analysis and runtime proof are different things.
Run one focused pass
Start with a bounded pass—Review a new order API version for fields, error bodies, status codes, consumer impact, and migration path. Put the input version, time window, and accountable owner in one place. Then link each judgment to an artifact. Finish with one validation action that can change the decision.
A contract includes schema, semantics, and error behavior; breaking changes need consumer migration paths. The handoff should include an evidence index, assumptions that still need checking, and an action the next person can run without reconstructing the conversation. Plain work. It holds up.
Run one focused pass
Start with a bounded pass—Review a new order API version for fields, error bodies, status codes, consumer impact, and migration path. Put the input version, time window, and accountable owner in one place. Then link each judgment to an artifact. Finish with one validation action that can change the decision.
A contract includes schema, semantics, and error behavior; breaking changes need consumer migration paths. The handoff should include an evidence index, assumptions that still need checking, and an action the next person can run without reconstructing the conversation. Plain work. It holds up.
Advanced use: turn one analysis into a maintained mechanism
A contract includes schema, semantics, and error behavior; breaking changes need consumer migration paths.
Keep input versions and source IDs with every result. When requirements, code, environment, or data change, recompute only affected judgments and mark them changed, unchanged, or needs-review. Old conclusions are not new evidence.
A three-Skill chain
change-impact-analysis → api-contract-testing → regression-test-selection
| Handoff | Payload | Receiver check |
|---|---|---|
| Upstream to api-contract-testing | Source versions, scope, risk, open items | Staleness and conflicts |
| api-contract-testing to downstream | Judgments, evidence index, residual risk, tasks | Executability and ownership |
| Feedback to api-contract-testing | Runs, defects, changed facts | Baseline and regression scope |
Hand over a summary, an evidence index, and locations for the source artifacts. That gives the receiver enough context and keeps the trail recoverable.
Team gates
| Gate | Check | Failure action |
|---|---|---|
| api-contract-testing input | Version, environment, sources, and owner | Stop and list gaps |
| api-contract-testing artifact | Material claims have basis, status, and impact | Return for evidence |
| api-contract-testing execution | Command, query, or verification path is repeatable | Classify infrastructure or test issue |
| api-contract-testing decision | Residual risk has an accepter and date | Do not enter the next stage |
Common traps
- Listing checks without input conditions, expected results, or evidence.
- Marking every finding high priority and removing the team’s ability to choose.
- Refusing to produce a bounded first pass, or presenting guesses as facts.
- Treating one success or one anomaly as long-term behavior while ignoring repeated trials and version changes.
Two practical questions
Can I start with incomplete input?
Yes. Produce a constrained first pass with known facts, assumptions, gaps, and the smallest validation action. Missing environment, data, or permission cannot support an execution claim.
When is human confirmation required?
The accountable owner must confirm scope trade-offs, risk acceptance, production actions, data permission, and release decisions. The Skill organizes evidence and options; it does not grant authority.
Run API Contract Testing with one real artifact and keep the input, output, human edits, and verification evidence in the same work chain. That is what makes the next change cheaper to assess.
References
- API Contract Testing prompt:https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-contract-testing/prompts/api-contract-testing.md
- Awesome QA Skills: API Contract Testing Skill source:https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-contract-testing
- Awesome QA Skills on GitHub:https://github.com/naodeng/awesome-qa-skills
- API Contract Testing Skill details:https://inaodeng.com/en/qaskills/api-contract-testing/