liveBook · Manning

Compatible migration pattern

As explained in Automating API Delivery

The Compatible migration pattern is an API migration strategy in which one API service handles requests from consumers using multiple compatible API versions.

The compatible migration pattern lets consumers depend on different API versions while sending every request to one API service that handles those versions. section 4.10

A version change module translates the latest service response into the consumer’s requested version. Separate modules apply transformations backward from the current version until the desired version is reached, keeping compatibility logic outside the core service code. section 4.10

Stripe-style version handling

Stripe uses declarative version change modules to transform resources returned by the latest API implementation for consumers using older API versions. This lets core developers add features without embedding every older-version rule in the service itself. section 4.10

Figure 4.6 Jean-Jacques Dubray’s three models of API version migration. The cost of version migration for each model is illustrated in the chart. (Source: This is adapted from JJ’s original diagram available at https://mng.bz/0GON, along with the accompanying equations.)
figure

Compare the compatible pattern with point-to-point and knot migration models, including their differing version-maintenance costs. section 4.10

How Automating API Delivery covers it

How deep it goes
Explains response transformations, module ordering, and separation from core code, but does not provide implementation syntax.
Examples
Uses Stripe’s version change modules and a cost comparison with point-to-point and knot migration models.
What you can do after
Evaluate/understand how response transformations preserve older API contracts while the core service advances.
How it connects
Connects API version migration with backward compatibility, response transformation, and separation of concerns.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.