Automatically transform source code comments into professional, interactive API documentation like OpenAPI and Swagger.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install api-docs-generator
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install api-docs-generator using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is API Docs Generator?
API Docs Generator is a robust utility designed to streamline the documentation lifecycle by extracting metadata directly from your source code. By incorporating this tool into your Openclaw Skills workflow, you can ensure your API reference remains accurate and synchronized with your implementation. It eliminates the manual labor of writing specifications, allowing developers to focus on building features while the tool handles the formatting.
This skill supports a diverse ecosystem of backend frameworks including Express.js, FastAPI, Flask, Gin, Spring Boot, and Rails. It provides a standardized way to describe your RESTful services, making it easier for frontend developers and external partners to consume your APIs through clear, interactive documentation.
API Docs Generator Use Cases
- Synchronizing API documentation with rapid code changes in real-time.
- Generating interactive Swagger UI or Redoc layouts for team collaboration.
- Exporting Postman Collections to facilitate automated API testing.
- Converting legacy code comments into modern OpenAPI 3.0 specifications.
How API Docs Generator Works
- Scan the designated source code directory containing route definitions and comments.
- Parse framework-specific annotations and docstrings to identify endpoints and schemas.
- Map extracted data to the selected specification format such as Swagger 2.0 or OpenAPI 3.0.
- Compile the results into a structured JSON or YAML file.
- Export the documentation to the specified output path for hosting or testing.
API Docs Generator Setup
The tool is designed for immediate use within the Openclaw Skills ecosystem. No additional external dependencies are required for the core generation logic.
# Basic command to generate OpenAPI docs
api-docs-generator openapi --input ./src --output docs/openapi.json
API Docs Generator Data Schema & Taxonomy
The generator organizes data based on the standardized OpenAPI and Swagger taxonomies. The resulting output maps code logic to the following schema structure:
| Property | Description |
|---|---|
| paths | Maps internal routes to public API endpoints |
| components | Defines reusable data models and security schemas |
| info | Includes API versioning, titles, and descriptions |
| tags | Organizes endpoints into logical groups for UI rendering |
Output files are generated as valid .json or .yaml documents ready for ingestion by standard API tools.
API Docs Generator Advanced Features
- Postman Collection support for immediate testing environment setup.
- Auto-detection of API routes across multiple languages and frameworks.
- Flexible formatting options for both JSON and YAML outputs.
- Command-line overrides for API titles, versions, and descriptions within Openclaw Skills automation.
SKILL.md
Loading
Related Openclaw Skills
AI Content Generator
A streamlined automation tool for generating high-quality marketing copy, blog posts, and social media content using advanced AI models.
Screenshot Capture
A high-performance Windows screen capture utility designed for AI vision integration and desktop automation.
Trading Signals WebSocket
A real-time cryptocurrency signal generator that connects exchange WebSocket price feeds to technical strategies and Telegram alerts.
Crypto Backtest Engine
A fast, scriptable crypto futures backtesting engine supporting multiple exchanges and technical indicators.
API Monitor Dashboard
A robust real-time API monitoring and alerting system designed to track uptime, performance, and error rates.
Auto Workflow Builder
A comprehensive visual engine for building and executing automated workflows with 100+ integrations and no-code logic.
Featured*
