Communicating API retirement

Sharing that your API is being retired can be done in a way similar to what you learned in Chapter 17 when you read about API versioning. However, in this case, you’re not focused on changes and incompatibilities. Instead, you’re focused on conveying to stakeholders that the API will cease to exist. It’s important to use a positive tone, communicate ahead of time, and clearly explain the reasons behind the retirement.

You should trigger the communication process as soon as you know you’re going to retire the API. This is to give existing consumers and stakeholders enough time before the actual retirement happens. As with incompatible API changes, consumers need time to adapt. However, in the case of a whole API ceasing to exist, customers might need months to adjust. That’s why it’s critical to start communicating right from the moment you identify there will be a retirement. It will give you a head start so...