Backward compatibility lets existing clients continue using an API after changes. In REST/JSON APIs, additions such as endpoints, optional request attributes, and response fields are compatible when they preserve existing behavior. section 8.2.2
When a change would disrupt existing clients:
- Run old and new API versions side by side while clients migrate. Versions can use URL prefixes such as /api/v1 and /api/v2, or media types such as application/vnd.example.v2+json. section 8.2.2
- Communicate retirement plans for older versions with the Sunset HTTP response header. section 8.2.2
Figure 8.6 A service must implement a breaking API change by supporting both the new and old versions of the API for the deprecation period. Clients that haven’t yet been updated can use the old version.
Shows old and updated clients using separate API versions during the deprecation period. section 8.2.2





















