How to tell what changed with your OpenAPI specification
How to tell what changed with your OpenAPI specification

I assume you’re trying to compare an original and an updated spec or want to check a single spec against a previous commit in a Git repo.

We will use an application called openapi-changes.

Watch the video

This video will walk you through how to use openapi-changes and will showcase all the available commands and how to use them.

What is openapi-changes?

openapi-changes is the world’s sexiest OpenAPI breaking change detector. It allows you to compare two OpenAPI specifications and see what changed. It’s like git diff for OpenAPI (but way, way sexier)

More information about openapi-changes is available over on the pb33f wiretap site.

Installing openapi-changes

There are a few ways to install openapi-changes:

Installing using homebrew

brew install pb33f/taps/openapi-changes

Installing using npm/yarn

npm install -g @pb33f/openapi-changes yarn global add @pb33f/openapi-changes

Installing using docker

docker pull pb33f/openapi-changes

Running openapi-changes using docker

docker run --rm -v $PWD:/work:rw \ pb33f/openapi-changes summary original-openapi.json modified-openapi.json

Installing using curl

curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh

Read the openapi-changes quickstart

This video is an extended version of the openapi-changes quickstart.