Verification · Static analysis · API compatibility checking
HTTP API diff
Compare OpenAPI documents for breaking changes, and lint them for style.
How to build it
- Export the OpenAPI document from the base branch and from the head branch in CI.
- Run oasdiff breaking between the two files and fail on breaking changes without a version bump.
- Lint the head document with Spectral rules and post the result on the pull request.
Signals in a repository
- A CI step that runs oasdiff breaking or oasdiff changelog on OpenAPI files.
- A .spectral.yaml or .spectral.yml ruleset in the repository.
In practice
No scanned repository runs a tool for this check. The steps above are the only guidance.