OpenAPI-diff
A command-line tool that compares OpenAPI specifications and renders their differences in several formats.
By OpenAPITools
Compare OpenAPI-diff with another product
Alternatives
See all alternativesAbout OpenAPI-diff
OpenAPI-diff compares OpenAPI 3.x specifications and can render differences as HTML, plain text, Markdown, Asciidoc, or JSON. It reads specifications from JSON files or HTTP URLs and examines changes to parameters, responses, endpoints, and HTTP methods.
The project also offers a Maven plugin that can report API changes during a build and optionally fail when it finds a compatibility break.
Strengths
- Renders differences in HTML, text, Markdown, Asciidoc, and JSON
- Reads specifications from local JSON files or HTTP URLs
- Includes a Maven plugin for build checks
Limitations
- Requires Java 8.
- Supports OpenAPI specification v3.0.
Details
- Pricing
- FreeFree and open source under the Apache-2.0 license.
- License
- Apache-2.0
- Developer
- OpenAPITools
- Platforms
- Command line
- How it runs
- Downloadable app
- Best suited for
- API developers checking changes between OpenAPI specifications
- Categories
- API clients, Developer tools
- Last verified
- Added
- Provenance
- Selected from the Homebrew formula