http-generate
Automates the generation of .http request files for Spring Boot REST controllers to simplify API documentation and testing.
Introduction
The HTTP Generator is a specialized automation skill designed for Spring Boot developers to streamline the creation of API documentation and testing suites. By scanning project directories for Java files annotated with @RestController or @Controller, it intelligently extracts endpoint mappings, HTTP methods (GET, POST, PUT, DELETE), and parameter configurations including @RequestParam and @PathVariable. It generates standardized .http files that are immediately compatible with IDE-based REST clients, ensuring that API samples are kept in sync with the codebase.
-
Automatically discovers and maps REST endpoints across complex multi-module Spring Boot projects.
-
Supports advanced mapping patterns including request parameter defaults, path variables, and URL encoding for internationalized content.
-
Generates well-formatted .http files featuring detailed comments, full URL paths, and logical grouping via ### separators for seamless navigation.
-
Facilitates team collaboration by providing ready-to-use request samples for new modules or refactored interfaces.
-
Eliminates manual documentation overhead, reducing the discrepancy between API implementations and testing specifications.
-
Execute the script using python .claude/skills/http-generate/scripts/http_generator.py [module_path] to target specific modules or use the 'all' parameter for full project coverage.
-
The tool requires a clean separation of module paths; ensure your controllers follow standard Spring Boot naming conventions ending in 'Controller.java'.
-
Custom output file naming is supported for tailored integration into existing documentation workflows.
-
Designed for environments utilizing Spring AI Alibaba frameworks and standard Spring Web dependencies.
-
Ensure the environment allows execution of Python scripts for file system interaction and source code analysis.
Repository Stats
- Stars
- 2,614
- Forks
- 1,100
- Open Issues
- 1
- Language
- Java
- Default Branch
- main
- Sync Status
- Idle
- Last Synced
- May 3, 2026, 04:01 PM