We will get to the sexy part in a moment, but in a nutshell openapi-changes
allows you
to see and explore what has changed with your OpenAPI Specification, between a single change,
or for all time!
Explore OpenAPI change history using a terminal or a browser, you decide which experience suits you. Perfect for individual use, or in a CI/CD pipeline for automation.
This is an early tool and is active, daily development
Have you ever seen an OpenAPI diff report look like this?
What about a terminal UI that does the same?
See all the documentation at https://pb33f.io/openapi-changes/
Are you ready to try it out?
brew install pb33f/taps/openapi-changes
npm i -g @pb33f/openapi-changes
If you prefer yarn (recommended)
yarn global add @pb33f/openapi-changes
curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh
docker pull pb33f/openapi-changes
To run, mount the current working dir to the container like so:
docker run --rm -v $PWD:/work:rw pb33f/openapi-changes summary . sample-specs/petstorev3.json
The
console
cannot run via docker.
Check out all the docs at https://pb33f.io/openapi-changes/