liveBook · Manning

Point-to-point migration pattern

As explained in Automating API Delivery

The Point-to-Point migration pattern is an API migration strategy in which different API versions remain deployed so consumers can migrate independently.

The Point-to-Point migration pattern keeps separate API versions deployed in production, allowing consumers to migrate independently rather than coordinating one organization-wide cutover. section 4.10

The pattern shifts migration responsibility between consumers and providers:

  • Consumers choose when to migrate, reducing the immediate time and cost of upgrading. section 4.10
  • Some consumers may remain on an older version indefinitely if it continues to meet their needs. section 4.10
  • Providers absorb the operational cost of maintaining several API services in production. section 4.10
  • Compared with the Knot pattern, Point-to-Point reduces coordinated migration cost but can become more expensive than the Compatible pattern as versions accumulate. 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 Point-to-Point with Knot and Compatible migration models using the cost illustration for growing numbers of API versions. section 4.10

How Automating API Delivery covers it

How deep it goes
Defines deployment and cost trade-offs, but stops short of implementation procedures or version-retirement guidance.
Examples
Uses multiple API services running different versions and consumers migrating at their convenience as the operational example.
What it assumes
Assumes familiarity with API consumers, providers, production deployment, and API versioning.
What you can do after
Evaluate API migration options by comparing consumer flexibility against the provider’s cost of maintaining multiple versions.
How it connects
Contrasts API versioning with the Knot migration pattern and the Compatible migration pattern.

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.