18
How do you holistically document microservices in a multi-repo setup?
(programming.dev)
Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!
Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.
Hope you enjoy the instance!
Rules
Follow the wormhole through a path of communities !webdev@programming.dev
I manually redraw my service architecture because I can create higher quality documentation than when trying to auto-generate it.
But you can get a baseline depending on which Cloud you use. For example, in AWS you can use workload discovery - that generates a system overview.
Yes, for example, if your build server exposes the API with an OpenAPI scheme, you can use the build server to generate a client library like a nuget or npn.
Then in the API consumer you can add a build step that checks if there are new version of the client library. Or setup dependabot that creates PRs to update those dependencies