img/favicon.ico" />
MyNew Technologies

How to document an API change for other teams

Document a change before an application that depends on it begins to see the new behavior.

What to do

  1. Record the route, request fields, response fields and relevant error codes in the interface description.
  2. Show how an old client behaves when a field is missing or added, using test data.
  3. Tell each consumer when the change will arrive and who owns compatibility testing. Have one consumer review the example.

Reference: OpenAPI Specification.

Related MyNew service: Software Development.