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
File Explorer
Download Latest Version (.zip)- change-list.png
- change-report.png
- console.gif
- explorer-deletion.png
- file-diff.png
- focus-diff.png
- roger-mode-explorer.png
- roger-mode-items.png
- summary.gif
- tektronix.png
- timeline-overview.png
- timline-explorer.png
- ui.gif
- console.tape
- summary.tape
- build.yaml
- publish.yaml
- tag.yaml
- openapi-changes.js
- spec_left.yaml
- spec_right.yaml
- test-config.yaml
- command_surface_test.go
- common.go
- common_test.go
- config.go
- config_test.go
- console.go
- console_test.go
- engine.go
- engine_test.go
- flag_surface_test.go
- flatten_report.go
- flatten_report_test.go
- html_report.go
- html_report_test.go
- left_right_sources.go
- loaders.go
- loaders_test.go
- markdown_report.go
- markdown_report_test.go
- paths.go
- paths_test.go
- petstore_regression_test.go
- report.go
- report_common.go
- report_test.go
- root.go
- root_test.go
- summary.go
- summary_test.go
- test_helpers_test.go
- version.go
- version_test.go
- windows_subprocess_test.go
- github.go
- github_test.go
- options.go
- read_local.go
- read_local_test.go
- revision_documents.go
- revision_fs.go
- revision_fs_test.go
- header.gohtml
- report.gohtml
- bundle-lite.js
- bundle.css
- bundle.js
- report-shell-base.ts
- report-shell-lite.ts
- report-shell.ts
- report.css.ts
- elk-layout-worker-inline.test.ts
- elk-layout-worker-inline.ts
- icon-registry.ts
- main-lite.ts
- main.ts
- fixtures.ts
- report-shell-data-loading.test.ts
- report-shell-render.test.ts
- report-shell-state.test.ts
- setup.ts
- index.html
- package-lock.json
- package.json
- tsconfig.json
- vite.config.ts
- vitest.config.ts
- generator.go
- generator_test.go
- config.go
- counts.go
- counts_test.go
- scope_detection.go
- scope_detection_test.go
- gitrepo.go
- commit.go
- progress.go
- report.go
- config.js
- postinstall.js
- invalid-config.yaml
- partial-config.yaml
- valid-config.yaml
- petstorev3-original.json
- petstorev3.json
- prepare-demo-fixture.sh
- render-demos.sh
- block_range.go
- block_range_test.go
- cache.go
- cache_test.go
- code_modal.go
- code_modal_test.go
- diff.go
- diff_test.go
- glamour_style.go
- highlight.go
- highlight_test.go
- keys.go
- model.go
- model_test.go
- report_modal.go
- report_modal_test.go
- styles.go
- tree.go
- tree_test.go
- tree_utils_test.go
- .gitignore
- .goreleaser.yaml
- AGENTS.md
- Dockerfile
- go.mod
- go.sum
- LICENSE
- Makefile
- openapi-changes-logo.webp
- openapi-changes.go
- package.json
- README.md
# Installation Guide
git clone https://github.com/pb33f/openapi-changes
Downloads the entire project code from GitHub to your computer.
cd openapi-changes
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommendedbrew install pb33f/taps/openapi-changes
Installs the pre-built package via Homebrew β no source build required.
npm i -g @pb33f/openapi-changes
Installs the package published on the npm registry globally β no need to clone the source.
curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh
Downloads and runs the official install script in one line β this handles the full setup automatically.
Pulled directly from this repo's README.
3. Docker
Easy- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker pull pb33f/openapi-changes
Type this command into your terminal and run it.
docker run --rm -v $PWD:/work:rw pb33f/openapi-changes summary . sample-specs/petstorev3.json
Runs the built image as an actual container.
docker run --rm -it -v $PWD:/work:rw pb33f/openapi-changes console . path/to/openapi.yaml
Runs the built image as an actual container.
Pulled directly from this repo's README.
4. Node.js
Easynpm i -g @pb33f/openapi-changes
Installs the package published on the npm registry globally β no need to clone the source.
yarn global add @pb33f/openapi-changes
Type this command into your terminal and run it.
Pulled directly from this repo's README.
5. Go
Mediumgo build -o bin/openapi-changes .
Compiles the Go program into an executable.
Pulled directly from this repo's README.
6. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
Pulled directly from this repo's README.