Automating API Changelogs: How to improve API developer experience

API products should change to adapt to changing needs and consumer groups. But how do you make changes without disrupting existing consumers? Avoiding breaking changes is a good idea, and documenting all changes in an easily consumable changelog is another good idea.

Bianca Lisle of @MongoDB explains how to document API changes. Part of the challenge is to make sure that existing consumers of the API know what's going on. Another challenge is to make sure that the process of generating SDKs wasn't affected by changes in the API. All of this is made possible by tracking and managing API changes in an automated way:

I'd like to thank Reuven Harrison of oasdiff for connecting me with Bianca Lisle. It's always interesting to hear about new tools and practices in the API space, but it's even better to see these tools and practices in action in real-life scenarios. You can find all the tooling discussed in this video at the following links:

#api #apimanagement #changemanagement #changelog #developerexperience #dx #apidocumentation #documentation #apiplatform #gettingapistowork #digitaltransformation

[apiopsatlanta]

Classic DevEx journey intersection with an API (that could be a product?). So, Erik, episodes like this one do indeed (finally) answer the question: "Does developer experience matter and/or is overrated for APIs?" Me: Yes, it does matter, and it should be considered early on in the API lifecycle.

regards,
Miguel

[FLASNE]

The tools is very nice however it does not handles OAS 3.1 (ticket open since 4 years) 🤕