oasdiff is an open-source tool used to compare OpenAPI Specification (OAS) files to identify differences and, critically, detect breaking changes. It helps developers maintain API backward compatibility by automating the detection of updates that could disrupt existing clients.
Breaking Change Detection: Automatically identifies changes that break integrations, such as removing a required field, changing a parameter type, or deleting an endpoint.
User-Friendly Changelogs: Generates a human-readable summary of all significant API changes, including both breaking and non-breaking updates.
Deep Diffing: Produces comprehensive reports covering paths, operations, parameters, request bodies, responses, schemas, enums, security, and more.
Multi-Format Support: Outputs reports in YAML, JSON, Text, Markdown, HTML, and JUnit XML.
Flexible Comparison: Compares local files, remote specs via HTTP/S, or even entire collections of specifications.
Customization: Supports ignoring specific breaking changes via configuration files and allows for custom breaking change rules