OpenAPI breaking-change detection for API teams.
oasdiff is the open-source toolchain teams use to catch breaking changes in OpenAPI specs before they ship. Run it as a CLI, in CI via the GitHub Action, or use the hosted side-by-side review workflow at oasdiff.com to approve or reject each change with a commit-status check.
- Diff and changelog. A precise, machine-readable diff between any two OpenAPI specs, plus a human-readable changelog.
- Breaking-change checks. A library of rules that flag changes likely to break API consumers.
- PR annotations. The oasdiff GitHub Action marks breaking changes inline on the changed lines, in the Files Changed tab.
- Side-by-side review. Open any spec pair at oasdiff.com/diff for a visual review.
- Validate. Catch OpenAPI and JSON Schema violations standalone, no diff required.
Try it without installing:
docker run --rm -t tufin/oasdiff diff \
https://raw.githubusercontent.com/oasdiff/oasdiff/main/data/openapi-test1.yaml \
https://raw.githubusercontent.com/oasdiff/oasdiff/main/data/openapi-test5.yamlInstall:
brew install oasdiff # macOS
go install github.com/oasdiff/oasdiff@latest # Go
curl -fsSL https://raw.githubusercontent.com/oasdiff/oasdiff/main/install.sh | sh # macOS or LinuxOr paste two specs at oasdiff.com/diff.
| Repo | What it is |
|---|---|
| oasdiff/oasdiff | Core CLI and Go library |
| oasdiff/oasdiff-action | GitHub Action for pull-request CI |
For teams that need block-on-merge controls, approve / reject directly on the GitHub PR comment, and per-org policy: see oasdiff Pro.
- Apache-2.0 licensed
- Active development with regular tagged releases
- Used in CI by API teams across SaaS, fintech, dev-tools, and OSS
- Documentation: oasdiff.com/docs
- Support and partnerships: info@oasdiff.com
- Issues and feature requests: github.com/oasdiff/oasdiff/issues
- Terms of service: oasdiff.com/terms
- Privacy policy: oasdiff.com/privacy