DEV Community

Discussion on: Should you explicitly define APIs when using Microservices?

Collapse
 
namdets profile image
Jason Stedman

If your project is complex enough to have tens of microservices, the APIs should definitely be documented somehow.

Also, since one of the key benefits of microservices is being language agnostic so the right tool can always be chosen, that documentation should be language agnostic(swagger).

Complete API documentation when possible also helps each collaborating microservices to utilize TDD when updating for a new version of your API as unit tests rather than depending on some kind of hosted test instance.