Overview

AsyncAPI diff tool — detect every change, automatically

What the diff engine detects#

Breaking change types#

Channel removed · Operation removed (publish/subscribe/send/receive) · Message removed · Payload field removed · Payload field type changed · Required field added to a payload · Enum value removed

Non-breaking changes#

New channel added · New operation added · New message added · New optional payload field added · New enum value added · Description updated

Why automated AsyncAPI diffing matters#

As event-driven architectures evolve, their schemas grow complex, with intricate relationships between channels, operations, and messages. A simple text-based diff fails to understand the semantic meaning of the AsyncAPI structure — removing a channel or changing a message payload is a significant breaking change, but it might appear as a minor alteration in a text file.

How CodeRifts performs the diff#

The engine parses both the old and new AsyncAPI schemas, fully understanding the schema definition language and creating a canonical representation of each version. It performs a semantic comparison, categorizing every detected change by severity — breaking, non-breaking, or deprecation — and assigns a risk score.

Three ways to diff#

  • In-browserapp.coderifts.com/try, no signup required.
  • On every PR — Install the GitHub App; zero config.
  • Via API or CLIREST API or CLI.

See also: gRPC diff, OpenAPI breaking changes.

Updated

Was this page helpful?