APIDrift CLI

Detect API breaking changes before they break your code.

Quick Start

npx apidrift check https://petstore3.swagger.io/api/v3/openapi.json

Install

npm install -g apidrift

Commands

apidrift check <url>

Fetch an API schema and compare against the previous snapshot.

• Saves snapshots locally in .apidrift/
• Shows colored diff of changes
• Detects breaking changes automatically

apidrift check https://api.example.com/openapi.json

apidrift diff <url1> <url2>

Compare two API schemas side by side.

apidrift diff https://api.example.com/v1/openapi.json https://api.example.com/v2/openapi.json

Exit Codes

| Code | Meaning | |------|---------| | 0 | No changes detected | | 1 | Non-breaking changes detected | | 2 | Breaking changes detected |

CI/CD Integration

# GitHub Actions example
- name: Check API for breaking changes
  run: npx apidrift check https://api.example.com/openapi.json

Exit code 2 means breaking changes were detected — fail the build accordingly.

Supported Formats

• OpenAPI / Swagger (JSON)
• GraphQL Introspection

Zero Dependencies

APIDrift CLI uses only Node.js built-in modules. Requires Node.js 18+.

Cloud Dashboard

For team features, alerts, and auto-patch PRs: https://api-drift-beige.vercel.app

License

MIT