OpenAPITools/openapi-diff

Health v2 · maintenance only

Adoption not part of the score

1095 stars · 191 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

A Java-based utility that compares two OpenAPI 3.x specifications and reports the differences. It can render diffs as HTML, Markdown, Asciidoc, or JSON, and is available as a CLI, Maven library, and Docker image.

Use cases

• compare two openapi specs for breaking changes
• detect backward-incompatible api changes in ci
• generate a changelog of api differences as markdown
• diff swagger v3 specifications
• fail a build when api contract changes
• check if a new api version is backward compatible

When to choose

• you need to detect breaking changes between OpenAPI 3.x versions in CI/CD
• you want diff output in HTML, Markdown, Asciidoc, or JSON
• you need a Java library for programmatic OpenAPI comparison
• you want a ready-made CLI or Docker image for spec diffing

When to avoid

• you need to diff OpenAPI 2.0 (Swagger) specs only
• you need a general-purpose JSON or YAML diff tool
• you work outside the JVM ecosystem and don't want a Java-based tool

Facets

cli-tool · maturity active

developer-tools api-framework documentation apis developer-tools cli jvm openapi swagger api-diff backward-compatibility spec-comparison api-documentation docker macos

Member repositories

For agents

markdown · JSON · MCP: product_card(name="OpenAPITools/openapi-diff")