Java API Documentation Generator

Problem

In a Java Spring Boot codebase, endpoint definitions are scattered across multiple @RestController / @Controller classes. Frontend integration and test regression often require repeatedly confirming the HTTP method, path prefix, query parameters, request body fields, and response shape. Hand-maintained docs can miss parameters, stale examples, or interface changes.

How It Works

The skill first locates src/main/java or a user-specified controller package, then recursively scans .java files and selects controller classes. It extracts class-level @RequestMapping and method-level @GetMapping / @PostMapping / @PutMapping / @DeleteMapping / @PatchMapping, as well as @PathVariable, @RequestParam, @RequestBody, JavaDoc comments, and Swagger annotation descriptions or examples. A Python script then generates API_DOCUMENTATION.md, organized by controller, with endpoint summaries, parameter tables, request examples, response examples, and deprecation markers.

Boundaries

Parsing relies on regular expressions, so it covers common Spring Boot patterns but may be imprecise for complex generics, inherited interfaces, or dynamic routes. The generated docs do not include authentication details, and response examples are often placeholders. Add @ApiOperation, @ApiParam, and @ApiResponse in code, then manually verify real examples.