What problem does it solve?
Converts Java service and controller code into human-readable technical documentation and visual diagrams to reduce manual documentation effort, speed onboarding, and clarify complex business logic.
Core Features & Use Cases
- API Documentation Extraction: Detects controllers and endpoints, extracts URLs, HTTP methods, parameters, request/response schemas, and exceptions, and produces OpenAPI-style Markdown.
- Business Logic Summarization: Analyzes service-layer logic to produce step-by-step business flow descriptions in natural language.
- Architecture Mapping: Identifies class dependencies and interactions and generates Mermaid sequence or class diagrams to illustrate call chains and relationships.
- Use Cases: New API development, complex logic explanation, documentation completion, refactoring handover, and generating developer-ready docs for code reviews.
Quick Start
Scan the selected Java controller and service files and generate OpenAPI-style Markdown API docs, a business flow summary, and Mermaid diagrams saved to docs/.