Automatically generate OpenAPI/Swagger documentation by analyzing code signatures in Python, JavaScript, TypeScript, and Go.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install api-doc-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-doc-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 Doc Generator?
The API Doc Generator is a high-performance utility designed for the Openclaw Skills ecosystem. It streamlines the documentation process by programmatically analyzing source code to extract function signatures, parameters, and return types. By automating the creation of OpenAPI and Swagger specifications, it reduces manual errors and ensures that technical documentation remains synchronized with the latest code changes. This skill is essential for developers who want to maintain high-quality API references without the overhead of manual maintenance.
API Doc Generator Use Cases
- Converting Python Flask or FastAPI routes into OpenAPI specifications.
- Generating documentation for TypeScript-based cloud functions.
- Maintaining up-to-date Swagger files for Go microservices.
- Accelerating onboarding by providing instant API references via Openclaw Skills triggers.
How API Doc Generator Works
- The user provides source code or a file path to the skill via an Openclaw Skills command.
- The skill scans the code to identify functions, methods, and routes.
- It parses docstrings and type hints to determine parameter details and response models.
- The extracted metadata is formatted into a valid OpenAPI 3.0 JSON object.
- The finalized documentation is returned or saved to the workspace.
API Doc Generator Setup
To begin using the API Doc Generator with your project, install it via the command line:
openclaw install api-doc-generator
Ensure your project contains standard type annotations or docstrings to allow the Openclaw Skills engine to accurately parse your signatures.
API Doc Generator Data Schema & Taxonomy
The output follows the standard OpenAPI specification. Below is how the generated data is structured:
| Property | Description |
|---|---|
| openapi | Specifies the version (3.0.0). |
| info | Contains the API title and versioning. |
| paths | Maps the code functions to API endpoints. |
| components | Defines reusable schemas based on code types. |
API Doc Generator Advanced Features
- Cross-language compatibility across four major programming languages.
- Customizable output templates for specific documentation flavors.
- Integration with automated testing suites within the Openclaw Skills framework.
- Ability to handle complex nested objects and custom data types.
SKILL.md
Loading
Related Openclaw Skills
Lyrics Search
A specialized utility for AI agents to retrieve, sanitize, and display song lyrics using the public LrcApi.
TRIZ - Systematic Innovation Methodology
A powerful systematic innovation tool that uses the TRIZ methodology and Five Bridges framework to solve complex engineering challenges.
Openclaw Todo
A specialized plugin for managing task lists within markdown files using intuitive CLI commands and metadata markers.
Self-Healing Elvatis for OpenClaw
An automated recovery extension that detects and fixes session failures, rate limits, and disconnects for AI agents.
Clawra Selfie
An AI-powered skill that generates stylized selfies using MiniMax or fal.ai and automatically broadcasts them to various messaging channels.
Code Flow Visualizer
An automated utility that converts code snippets into Mermaid flowchart diagrams to help developers visualize and understand complex logic.
Featured*
