https://github.com/pb33f/openapi-changes
The world's sexiest OpenAPI breaking changes detector. Discover what changed between two OpenAPI specs, or a single spec over time. Supports OpenAPI 3.1, 3.0 and Swagger
https://github.com/pb33f/openapi-changes
diff oas3 openapi openapi-generator openapi-repo openapi-spec openapi-specification openapi3 swagger
Last synced: 4 days ago
JSON representation
The world's sexiest OpenAPI breaking changes detector. Discover what changed between two OpenAPI specs, or a single spec over time. Supports OpenAPI 3.1, 3.0 and Swagger
- Host: GitHub
- URL: https://github.com/pb33f/openapi-changes
- Owner: pb33f
- License: other
- Created: 2022-11-28T16:53:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T14:02:57.000Z (over 1 year ago)
- Last Synced: 2024-10-29T17:29:11.757Z (over 1 year ago)
- Topics: diff, oas3, openapi, openapi-generator, openapi-repo, openapi-spec, openapi-specification, openapi3, swagger
- Language: Go
- Homepage: https://pb33f.io/openapi-changes/
- Size: 43.8 MB
- Stars: 184
- Watchers: 1
- Forks: 16
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - pb33f/openapi-changes - The world's most powerful OpenAPI breaking changes detector. Discover what changed between two OpenAPI specs, or a single spec over time. Supports OpenAPI 3.2, 3.1 and 3.0 (Go)
README
[](https://discord.gg/x7VACVuEGP)
[](https://github.com/pb33f/openapi-changes/releases)
[](https://www.npmjs.com/package/@pb33f/openapi-changes)
[](https://hub.docker.com/r/pb33f/openapi-changes)
# OpenAPI Changes
## The world's **_most powerful and complete_** OpenAPI diff tool.
`openapi-changes` lets you inspect what changed in an OpenAPI specification between two files,
between git revisions of the same file, across local git history, or directly from a GitHub-hosted file URL.
It can render the same semantic change model as:
- an interactive terminal UI
- a terminal summary
- a machine-readable JSON report
- a markdown report
- a self-contained offline HTML report
It works well for local exploration, CI/CD checks, release notes, and API review workflows.
## How is it the 'most powerful and complete?'?
openapi-changes gives you the power to view all changes between two OpenAPI contracts, and over time in every which
way you can possibly think of. Graphs, trees, lists, diffs, JSON, mark down.
Has no network dependencies at all. Runs 100% offline, including the HTML report.
---
## Install with Homebrew
```bash
brew install pb33f/taps/openapi-changes
```
## Install with npm or yarn
```bash
npm i -g @pb33f/openapi-changes
```
If you prefer yarn:
```bash
yarn global add @pb33f/openapi-changes
```
## Install with cURL
```bash
curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh
```
## Install or run with Docker
```bash
docker pull pb33f/openapi-changes
```
Docker images are available for both `linux/amd64` and `linux/arm64`.
The published image configures Git to trust mounted repositories, so local git-history commands work without requiring extra `safe.directory` setup inside the container.
To run a command, mount the current working directory into the container:
```bash
docker run --rm -v $PWD:/work:rw pb33f/openapi-changes summary . sample-specs/petstorev3.json
```
To run the interactive `console` through Docker, allocate a TTY with `-it`:
```bash
docker run --rm -it -v $PWD:/work:rw pb33f/openapi-changes console . path/to/openapi.yaml
```
## Verify the install
Print the installed version:
```bash
openapi-changes version
```
---
### Summary view
### A full terminal UI
Comes in multiple themes! PB33F (Dark), Roger Mode (Light) and Tektronix (Retro Dark)
### Powerful HTML report with no rival.
A self-contained, offline HTML report with interactive timeline, change explorer graph, diff views, and more.
#### Timeline overview with change history chart
#### Interactive explorer graph
#### Change report breakdown
#### Side by side, focused, unified or inline diffing
#### Roger mode (monochrome light theme)
#### Tektronix mode (green monochrome)
---
## Comparing git revisions
Compare a file at different git revisions without checking out branches:
```bash
openapi-changes summary HEAD~1:openapi.yaml ./openapi.yaml
openapi-changes html-report main:api/openapi.yaml feature-branch:api/openapi.yaml
```
The `revision:path` syntax works with any git ref -- branches, tags, `HEAD~N`, commit SHAs.
The path is relative to the repository root. This works with all commands and supports
multi-file specs with `$ref` references resolved from the same revision.
---
## Documentation
### [Quick Start Guide 🚀](https://pb33f.io/openapi-changes/quickstart/)
Full docs: https://pb33f.io/openapi-changes/
- [Installing openapi-changes](https://pb33f.io/openapi-changes/installing/)
- [Configuring breaking changes](https://pb33f.io/openapi-changes/configuring/)
- [Command arguments](https://pb33f.io/openapi-changes/command-arguments/)
- Commands:
- [`console`](https://pb33f.io/openapi-changes/console/)
- [`summary`](https://pb33f.io/openapi-changes/summary/)
- [`report`](https://pb33f.io/openapi-changes/report/)
- [`markdown-report`](https://pb33f.io/openapi-changes/markdown-report/)
- [`html-report`](https://pb33f.io/openapi-changes/html-report/)
- [`completion`](https://pb33f.io/openapi-changes/completion/)
- [`version`](https://pb33f.io/openapi-changes/version/)
- [About openapi-changes](https://pb33f.io/openapi-changes/about/)
---
## Build from source
`openapi-changes` currently requires Go `1.25.0`.
```bash
git clone https://github.com/pb33f/openapi-changes.git
cd openapi-changes
go build -o bin/openapi-changes .
```
Or use `make`:
```bash
make
```
---
## Command overview
The current command surface is:
- `console` for the interactive terminal UI
- `summary` for fast terminal and CI output
- `report` for machine-readable JSON
- `markdown-report` for shareable markdown output
- `html-report` for the interactive offline browser report
- `completion` for shell completion scripts
- `version` for raw build version output
Run `openapi-changes --help` or `openapi-changes --help` for the live CLI surface.
### Terminal themes
The terminal-facing commands support multiple presentation modes:
- `--no-color` for the light Roger monochrome theme
- `--roger-mode` as an alias for `--no-color`
- `--tektronix` for the green monochrome terminal theme
See the [command arguments docs](https://pb33f.io/openapi-changes/command-arguments/) for the full shared flag set.
---
## Custom breaking rules configuration
`openapi-changes` supports configurable breaking-change rules via `changes-rules.yaml`.
### Use an explicit config file
```bash
openapi-changes summary -c my-rules.yaml old.yaml new.yaml
```
### Or let it auto-discover the default config file
```bash
openapi-changes summary old.yaml new.yaml
```
Default lookup locations:
1. `./changes-rules.yaml`
2. `~/.config/changes-rules.yaml`
### Example
```yaml
pathItem:
get:
removed: false
post:
removed: false
put:
removed: false
delete:
removed: false
schema:
enum:
removed: false
parameter:
required:
modified: false
```
Each rule supports:
- `added`
- `modified`
- `removed`
For the full rules reference and more examples, see the
[configuration docs](https://pb33f.io/openapi-changes/configuring/).
---
See the full docs at https://pb33f.io/openapi-changes/