openapi-diff VS oasdiff

Introducing our star player for detecting breaking changes: OpenAPI Diff. The good news? You can fire it up locally with Docker. Here’s how:

Now that we have a way to lookup our API’s behavior with Git, we can start testing for breaking changes between versions of our API. We’ll be using Optic (an open source tool I created) to do just that. If you are looking for other options I recommend https://github.com/OpenAPITools/openapi-diff or https://github.com/Tufin/oasdiff.

One option is to use OpenAPI to define the contracts. And then when you update the definitions, run something like https://github.com/OpenAPITools/openapi-diff to make sure there are no incompatibilities.

In this article, I will show you how to create an automated OpenAPI schema validation to ensure your API stays backwards compatible. We will use NestJS CLI plugin to generate a schema and oasdiff to validate it.

If you use APIs make sure you don’t break them: https://github.com/Tufin/oasdiff

We will use an open-source GitHub action, oasdiff-action, based on the tool ‘oasdiff.’

Nice, Have you come across this tool oasdiff from the article? It may help with detect API breaking changes in swagger

While you might wish that pull request reviewers would spot any breaking changes, relying solely on this method is not certain and might lead to failure eventually. If you have OpenAPI/Swagger documentation for your APIs, these can be version-controlled and included in a CI pipeline. APISIX doesn't natively support direct integration with version control systems like Git for API specification changes. However, you can set up a process outside APISIX. Tools like Oasdiff or Bump can identify changes in API specs, and trigger a CI pipeline (add GitHub Action) that runs tests against the route endpoints in APISIX to ensure no breaking changes are introduced.