Self-documenting services: generating a microservice canvas
The microservice canvas is a great way to document a service. One drawback, however, is that like all forms of documentation, it often becomes out of date.
To solve this problem, I’ve created the Microservice Canvas Tools project.
This project keeps the canvas up to date by dynamically generating a microservice canvas for a running service using a combination of reflection/introspection and explicit metadata.
It exposes a service’s canvas via the /canvas.adoc, /canvas.html, /canvas.yml, and /canvas.json endpoints.
The project is still very much work in progress but please take a look and let me know what you think.
To learn more
- Read my Microservices patterns book
- Read or watch my O’Reilly Software Architecture conference keynote
- Talk to me about my microservices consulting and training services including how I can help you create a microservices migration roadmap for your organization
- Learn more about microservices at adopt.microservices.io
Premium content and office hours is now available for paid subscribers at 
