4 Breaking change checks: Managing API evolution
This chapter covers
- Running breaking change checks
- Using API versioning schemes
- Defining a breaking change policy
At the design stage of your API product, your API team iterates on your API design and updates your OpenAPI definition files. It’s useful to know whether any change your team introduces isn’t backward compatible. In this chapter, I show how to use API diff tools to understand API definition file changes and how to detect which of them are breaking changes. One way to avoid introducing breaking changes to existing API consumers is API versioning, and I discuss different API versioning schemes and scopes used by different organizations. I also explain the costs of introducing new ...
Get Automating API Delivery now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.