How do you document your microservices?

Question

Our team is about 100 people, and ~8 microservices. Public endpoints and their parameters are documented (in a shared repo of swagger docs). However, the operations, side effects, dependencies of each API are not documented in any consistent way. Do you have any processes, or technologies that help you track service internals and dependencies?

tcbasche · Accepted Answer

For managing services themselves I might recommend something like backstage.io but only from what I've heard, and not from personal experience.Only you can know the operations of a service, so if a service had a /docs route (or a landing page or something) which documented what its purpose is, why it exists etc. and what needs to be running in order for it to achieve all that, then that might be a good first step. Beware of dated information though ...