openapi-diff
Advanced tools
A CLI tool to identify differences between Swagger/OpenAPI specs.
Install the tool using NPM:
npm install --global openapi-diff
Invoke the tool with two paths to Swagger/OpenAPI files in order to find differences between them, these paths can either be paths to the specs in the local filesystem or URLs to the specs (sorry, no YML support just yet). The Open API specs should be in JSON format.
openapi-diff /path/to/old/openapi.json /path/to/new/openapi.json
The tool's output will display the amount and type of changes (breaking, non-breaking, unclassified), and then list the changes with the relevant info.
The command will exit with an exit code 1 if any breaking changes were found, so that you can fail builds in CI when this happens.
See SPEC_SUPPORT.md
FAQs
A CLI tool to identify differences between Swagger/OpenAPI specs.
We found that openapi-diff demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.