Menu

How to tell API consumers about a breaking change (when you don't know who they are)
📰

How to tell API consumers about a breaking change (when you don't know who they are)

DEV Community: microservices·Graphwake·about 3 hours ago
#vjIf14Ec
#devtomicroservices#devto#dev#api#engineering
Reading 0:00
15s threshold

Most advice on notifying API consumers is written for public APIs. Publish a changelog, email your developer list, add a Deprecation header, done.

Inside a company the problem is different. You usually know what you are about to change. What you often don't know is who calls it . The service has been around for three years, two teams have been reorganized since, and somebody's batch job reads a field you are about to rename.

This post is a short playbook for that situation: find the consumers first, tell only them, give a date and an action, then follow up.

Why the usual channels fail inside a company

Email to everyone gets filtered out within a week. People learn that most of those mails are not about them.

A changelog only helps the readers who go and look at it.…

Continue reading — create a free account

Join HashtagPLUS to read full articles, follow hashtags, vote, and join the conversation.