Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 5 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 (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T14:02:57.000Z (about 2 months ago)
- Last Synced: 2024-10-29T17:29:11.757Z (about 1 month 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 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 (Go)
README
[](https://discord.gg/x7VACVuEGP)
[](https://github.com/pb33f/wiretap/releases)
[](https://www.npmjs.com/package/@pb33f/openapi-changes)
[](https://hub.docker.com/r/pb33f/openapi-changes)
# OpenAPI Changes
## The world's **_sexiest_** OpenAPI diff tool.
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
## How is it the 'sexiest'?
Have you ever seen an OpenAPI diff report look like this?
What about a terminal UI that does the same?
---
## Documentation
### 👉 [⚡ Try the online Demo ⚡](https://pb33f.io/openapi-changes/demo/) 👈
### [Quick Start Guide 🚀](https://pb33f.io/openapi-changes/quickstart/)
See all the documentation at https://pb33f.io/openapi-changes/
- [Installing openapi-changes](https://pb33f.io/openapi-changes/installing/)
- [Command arguments](https://pb33f.io/openapi-changes/command-arguments/)
- CLI Commands
- [`console` command](https://pb33f.io/openapi-changes/console/)
- [`html-report` command](https://pb33f.io/openapi-changes/html-report/)
- [`report` command](https://pb33f.io/openapi-changes/report/)
- [`summary` command](https://pb33f.io/openapi-changes/summary/)
- [About openapi-changes](https://pb33f.io/openapi-changes/about/)
---
Are you ready to try it out?
## Install using homebrew tap
```bash
brew install pb33f/taps/openapi-changes
```
---
## Install using npm or yarn
```bash
npm i -g @pb33f/openapi-changes
```
If you prefer yarn _(recommended)_
```bash
yarn global add @pb33f/openapi-changes
```
---
## Install using cURL
```bash
curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh
```
---
## Install/run using Docker
```bash
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/