Contract Testing

You might say

The backend renamed a field in the response, and our frontend crashed on deploy. How can we catch this automatically on commit?

An automated test that records the requests and responses a consumer truly depends on, then verifies that the provider remains compatible.A profile page may read avatar_url and nickname. A consumer test records the request and minimum response; provider verification compares the backend's real response with that contract. Renaming avatar_url to avatar then fails CI before merge. This checks communication at a service boundary, not the whole page, network, or business calculation.

Know first

API Acceptance Criteria Integration Test

Contract Test

How contract testing verifies consumer and provider consistency

api.service.local/v1/users/42

Consumer records real needs

Profile page reads

const avatar = user.avatar_url
const name = user.nickname

Minimum response contract

GET /v1/users/42 → 200
{
  "avatar_url": "string",
  "nickname": "string"
}

The contract records only fields the page truly reads; the backend may return more.

How one field rename gets blocked before release

Before: both sides rely on an informal agreement: The profile page reads avatar_url, while a backend refactor renames it to avatar. Backend unit tests can still pass because they do not know which response fields the frontend depends on. The breakage may surface only during integration or after release.

Add the contract and return provider feedback: A consumer test records the minimum agreement for a real request: a successful status and the required id, avatar_url, and nickname fields with their expected types. Provider verification replays the scenario in CI; if avatar_url is missing, it should name the field and block the incompatible change. Pact is one common implementation tool, not a synonym for contract testing.

Prove the guard works: For acceptance, intentionally rename avatar_url and confirm the check fails. Restore the old field or add a compatibility mapping and confirm it passes. This proves the test can catch this breakage rather than merely adding another always-green script.

You can say this to an AI Agent

Our frontend depends on GET /v1/users/:id returning id, avatar_url, and nickname. Add a consumer contract from the fields the frontend actually reads, then verify the backend response in CI. Rename avatar_url to avatar and confirm the PR reports the missing field and cannot merge; restore compatibility and confirm the check passes.

Learn next

1Integration Test→2Acceptance Criteria→3Test Case→

Recommended tool

Web fine-tuning tool · Selector Pro

Select page elements for precise AI edits

Click a button, text, or card, note the change, then copy its exact location to AI.

Open Selector Pro website

A backend developer plans to rename user_id to uid. Which test catches this breakage fastest and cheapest before PR merge?

A. Manual live checks: deploy the breaking change directly to production and verify the dashboardB. Contract testing: validates against consumer expectations and fails CI before code mergesC. Backend unit tests: internal logic checks pass within the isolated service without client context