Quickstart

1. Create an account

Sign up at /register. A workspace is created for you on first login.

2. Add an endpoint

From the console:

1. Open Endpoints → New
2. Set name, URL, method, and environment
3. Save

Or import many endpoints from OpenAPI — see OpenAPI import.

3. Capture a baseline

Open the endpoint and click Capture baseline. APIDiffGuard fetches the live response and stores status, headers, and body as version v1.

4. Run a check

Click Run check. The latest response is compared to the active baseline. Breaking changes (removed fields, type changes, status class flips) show up in the Diff Viewer.

5. Gate CI (optional)

npx apidiff check --endpoint ep_users --fail-on breaking

Fail the job when the contract breaks — the same engine as the console.