API Versioning

About a year ago, I’ve written an article about evolving APIs. It describes some common situations, and also contains some tips on how to handle them, while minimizing the risk to your project.

Key recommendations:

  • improve the design of your API. In addition to identifying the business domain for a microservice, have a look at its dependencies as well. Reducing the number of possible interactions allows one to keep control even with increased complexity. It may also decrease the number of scenarios which need testing;
  • split into new services whenever necessary. Rarely changed modules of your existing codebase are prime candidates for extraction in separate microservices;

  • take time to deprecate old APIs. You only need to keep what’s needed, and old code should be constantly reviewed and improved. This will keep your product clutter free, decrease complexity and improve manageability.

The full article is available here:

https://www.cognizantsoftvision.com/blog/api-versioning/

Leave a comment