A practical guide to documenting production-ready Spring Boot applications using documentation-as-code principles. Covers three layers: README files for developer onboarding, architecture documentation using AsciiDoc with C4 diagrams (generated via PlantUML) and Architecture Decision Records, and REST API docs using Spring REST Docs instead of Swagger/OpenAPI. Also shows how to serve generated HTML and PDF docs directly from the Spring Boot app via a static resources setup and a simple controller, making versioned docs accessible per environment.

9m read timeFrom wimdeblauwe.com
Post cover image

Sort: