The problem
If you've worked with Spring Boot for a while, you've probably experienced this:
You join a project and there is:
- no architecture documentation
- no clear understanding of security
- no overview of how components interact
- incomplete or missing API docs
You spend days reading code just to understand what’s going on.
I ran into this constantly.
Why existing tools didn’t solve it
Swagger / OpenAPI helps — but only if:
- the code is already annotated
- or someone manually defines the spec
In many real-world projects, that’s not the case.
I also tried using AI tools, but:
- they don’t run locally
- they don’t understand full project context
- and they don’t generate structured documentation
What I built
I built a CLI tool that analyzes an existing Spring Boot repository and generates a complete technical documentation package automatically.
It runs locally inside your project.
Your code never leaves your machine.
What it generates
From an existing repo, it produces:
- Architecture documentation (layers, components, relationships)
- Security matrix (endpoints, HTTP methods, roles)
- UML diagrams (use cases, logical architecture, layered view)
- OpenAPI/Swagger annotations injected into the code
- Javadoc at method level
- Onboarding guide for new developers
- Traceability from requirements to implementation
- Payload documentation
How it works
You run it directly in your project:
springbootai analyze
https://www.youtube.com/watch?v=bI6FCiniWqU
👉 https://springbootai.com
Top comments (0)