What is a recommended practice when deprecating an API?

• A. Change endpoints without notice
• B. Issue a clear timeline, migration guides, and client communication
• C. Only document in internal wiki
• D. Immediately disconnect clients

Answer: (B)

Communicating a deprecation plan effectively requires planning and transparent communication with API consumers. The best practice is to publish a clear sunset timeline, provide migration guides, and actively inform clients. This approach gives developers a concrete deadline to update their integrations, test against the new endpoints or versions, and adjust their code without sudden outages. A solid migration guide should spell out what changes are needed, show the new endpoints or versions, outline any breaking changes, and include practical examples of requests and responses. Publishing the deprecation details in public docs, release notes, and a status or changelog, plus direct notices to known clients, helps everyone stay informed and reduces support burden. Reminders as the sunset date approaches improve the chances of a smooth transition. By contrast, changing endpoints without notice creates outages and frustration, documenting only in an internal wiki excludes external developers, and disconnecting clients immediately leaves users without a viable transition path.