Over the years of working with microservices, we’ve discovered key points that you have to keep track of in order to** maintain good visibility** and** be able to manage microservices**. Check out these simple rules down below.

Summary

1. Have an automated API interface documentation
2. Document release notes and related services
3. Define service owners for better communication
4. Document the dependencies of each service
5. Track your API consumers
6. Keep track of intents for changes of the services
7. A bonus tool to solve these problems

1. Have an automated API interface documentation

There are many tools out there to generate API documentation from the code. This approach is a clear winner compared to manual API documentation because:

1. the documentation does not get outdated as it’s generated frequently without any effort besides a few comment lines in the code,
2. some tools even allow making requests without setting up all of the request parameters in an external tool or terminal.

There are a lot of libraries to use depending on the programming language of a particular service. I like using tools that generate Swagger documentation that I can as well import to Postman if needed.

#microservices #startup #api