Automatically extracts Controller-level API definitions from Spring Boot Java projects into standard JSON formats for downstream documentation and frontend integration.
The fastest way to install a skill directly from the registry.
npx clawhub@latest install java-api-extractor
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
Copy this prompt to OpenClaw to install it automatically.
Help me install java-api-extractor using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Get the raw skill files in a ZIP archive.
The Java API Extractor is a highly efficient development tool designed to parse Java Spring Boot projects and automatically extract Controller-level interface definitions into a standard, structured JSON schema. This skill streamlines documentation workflows, allowing team members to quickly prepare backend specifications for frontend integration, API gateways, or product data platforms without writing manual OpenAPI definitions.
As part of the Openclaw Skills ecosystem, this tool automates metadata mapping, parses Spring MVC annotations, and extracts Swagger/OpenAPI details. It ensures that your backend definitions and API documentation stay completely synchronized, reducing manual errors and saving precious engineering hours.
src/main/java directory for @RestController and @Controller classes.@GetMapping, @PostMapping), method parameters, and Swagger annotations (like @ApiOperation).First, ensure you have the required runtime environment (Python is preferred, but Node.js is also supported).
# Extract the entire project to JSON (Python engine - default and preferred)
python scripts/extract_java_api.py --project "/path/to/msa-icmp-dev-manage" --output api-definitions.json
# Extract definitions from a specific Java package
python scripts/extract_java_api.py --project "/path/to/msa-icmp-dev-manage" --package "com.example.user.controller" --output user-api.json
# Extract definitions and push them directly to a target product platform
python scripts/extract_java_api.py --project "/path/to/msa-icmp-dev-manage" --prdid "PRD-2026-001" --push
# Run in verbose mode to log extensive debug details
python3 scripts/extract_java_api.py --project "/path/to/project" --output api.json --verbose
Alternatively, you can run the Node.js version of the Openclaw Skills parser if Python is not available in your environment:
# Node.js fallback parser invocation
node scripts/extract_java_api.js --project "/path/to/msa-icmp-dev-manage" --package "com.example.user.controller" --output user-api.json
The output schema structured as raw JSON matches standard API endpoints structures. Below is an example format:
[
{
"name": "Create User",
"path": "/api/user",
"method": "POST",
"description": "Creates a new user",
"requestParams": [
{
"name": "userName",
"type": "String",
"required": true,
"description": "Target username"
}
],
"responseSchema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "The generated user ID"
}
}
}
}
]
| Annotation Category | Supported Spring & Swagger Annotations |
|---|---|
| Request Mappings | @GetMapping, @PostMapping, @PutMapping, @DeleteMapping, @PatchMapping, @RequestMapping |
| Parameter Mappings | @PathVariable, @RequestParam, @RequestHeader, @RequestBody, @ModelAttribute |
| Documentation Annotations | @ApiOperation, @Operation, @ApiParam, @Parameter, @Tag, @Api |
| Java Class Type | JSON Type |
|---|---|
| String | string |
| Integer, int, Long, long | integer |
| Boolean, boolean | boolean |
| Double, double, Float, float | number |
| Date, LocalDateTime | string (date-time) |
| List |
array |
| Object | object |
Loading
A powerful bilingual toolkit designed to detect, eliminate, and score AI-generated writing patterns, helping you craft authentic, human-grade prose in English and Chinese.

A gate-based, automated AI agent workflow designed to guide product managers from a raw feature topic to a review-ready PRD v1.0, reducing development rework by 50%.

A design-oriented developer skill for compressing 6-step conversational dialogues into high-performance 3-step structured interactions for AI agents.

A closed-loop execution framework that turns raw operational logs into structured agent experiences through automated AI analysis and human-in-the-loop review.

Automate the transfer and synchronization of backend Java API definitions directly to product management data platforms.

Pushes backend API definitions (methods, paths, parameters, and responses) directly to frontend data interface platforms to achieve automated API documentation synchronization.








































