DocGen is a lightweight backend tool that automatically generates API documentation from Java Spring Boot repositories.
It scans source code, extracts REST endpoints, and produces structured documentation (OpenAPI + README-style summary).
- Clone GitHub repositories automatically
- Scan Java Spring Boot projects
- Extract REST endpoints using annotations
- Generate structured documentation
- Output:
- OpenAPI-style JSON
- Endpoint summary
- Project metadata
- Send a repository URL
- System clones the repo into a temporary directory
- Java files are scanned
- Endpoints are extracted using regex
- Documentation is generated
POST /analyze
Request Body: { "repoUrl": "https://github.com/user/repository" }
Response: { "jobId": "12345" }
GET /result/{jobId}
Response: { "jobId": "12345", "repoUrl": "https://github.com/user/repository", "status": "DONE", "project": { "name": "Generated Project", "description": "Auto generated API documentation from source code", "language": "java", "framework": "spring-boot" }, "endpoints": [ { "path": "/users/{id}", "method": "GET", "controller": "UserController", "handlerMethod": "getUserById", "description": "Auto generated endpoint" } ], "summary": { "totalEndpoints": 1, "controllersCount": 1 }, "generatedAt": "2026-04-28T00:00:00Z" }
- Java 17+
- Spring Boot
- Regex-based parsing (MVP)
- File system analysis
- No full AST parsing (regex-based extraction)
- No authentication
- No UI layer
- Best effort handler method detection
- Works best with standard Spring Boot structure
- Replace regex with JavaParser (AST-based parsing)
- Improve endpoint inference accuracy
- Add OpenAPI 3.0 full spec generation
- GitHub integration (auto sync on push)
- Web UI dashboard
- AI-powered endpoint descriptions
- SaaS deployment (multi-tenant support)
Automatically convert backend source code into readable API documentation with minimal effort.
Early MVP built for validation and experimentation.
Sina Pezeshki