An automated engineering skill that converts raw source code, URLs, or endpoint descriptions into enterprise-ready OpenAPI 3.0 standards, complete with multi-language SDKs and mock servers.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install mimo-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 mimo-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 Document Generator?
The api-doc-generator skill is designed to solve a perennial pain point in backend engineering: keeping API documentation synchronized with working source code. By injecting code blocks, framework routers, raw URLs, or unstructured endpoint definitions into an Openclaw Skills workflow, developers can instantly build standard OpenAPI 3.0 / Swagger references. This bypasses manual drafting processes and eliminates stale document drift.
Beyond basic schema documentation, this tool evaluates routing architectures, handles authentication mechanisms like JWT Bearer tokens or OAuth 2.0, and auto-generates clean, functional client SDK architectures. It equips teams with structured documentation formats, reducing the operational bottleneck often caused by missing schemas during cross-team integrations.
API Document Generator Use Cases
- Legacy Code Synchronization: Extracting structured metadata out of undocumented Python, Go, Java, or JavaScript backends into explicit OpenAPI maps.
- Frontend-Backend Contract Bootstrapping: Generating functional mock backend environments and test definitions before final server paths are fully deployed.
- Multi-Language SDK Generation: Producing working Client wrappers in Python, JavaScript, and native cURL expressions straight from a routing definition.
- API Governance and Migration Auditing: Compiling version migration blueprints and monitoring broken endpoint signatures during v1 to v2 code transitions.
How API Document Generator Works
- Input Identification: The skill parses incoming files, raw text, or remote URLs to isolate framework-specific routing annotations, path properties, or raw OpenAPI snippets.
- Parameter and Type Extraction: Extracts deep path parameters, query indices, header protocols, and body schemas while enforcing strict JSON validation parameters.
- Status Code Mapping: Correlates functional handler returns against standardized HTTP status code ranges alongside customized business logic failure codes.
- Security Definition Resolution: Analyzes the protocol context to map access rules, credential keys, and security schemas under components block setups.
- Specification Compiling: Generates a valid OpenAPI 3.0.3 specification structure in YAML or JSON formats.
- SDK and Boilerplate Bundling: Renders operational runtime execution examples for target environments including Python, JavaScript, and native curl statements.
- Mock Server Configuration: Emits ready-to-run Express environments loaded with dummy validation structures corresponding exactly to the spec specifications.
- Integration Test Delivery: Builds functional test files utilizing assertions to continuously check standard and error conditions.
API Document Generator Setup
To activate the specification generation engine within Openclaw Skills ecosystem environments, append the package name directly to your profile manifest or handle setup manually:
# Install the client-side dependencies and SDK test wrappers
npm install -g mock-server
# Run the auto-generated specification mocks locally
mock-server start --port 3000 --spec ./api_doc.yaml
API Document Generator Data Schema & Taxonomy
The skill manages its outputs across structural code files, static specifications, and documentation formats:
| Output File Name | Data Format | Description |
|---|---|---|
api_doc.md |
Markdown Text | Human-readable document overview featuring route lists and request fields. |
api_doc.yaml |
OpenAPI 3.0 Specification | The core machine-readable backend declaration map used by API managers. |
api_doc.html |
Static Web View | Rendered structural dashboard matching typical swagger-ui deployments. |
sdk_python.py |
Python Script | Executable requests-based client class featuring route definitions. |
sdk_javascript.js |
JavaScript ES6 Class | Promises-based client structure utilizing the fetch runtime API. |
sdk_examples.sh |
Shell Execution | Line-separated cURL operations verifying target parameters. |
mock_server.js |
Node.js Express Application | Lightweight sandboxed target server designed for instant contract mock testing. |
api_tests.js |
Jest / Mocha Blueprint | Integration test structure evaluating boundary scenarios and paging logic. |
API Document Generator Advanced Features
- Framework Abstract Parsers: Out-of-the-box support for reading routing abstractions across frameworks including FastAPI, Flask, Express, NestJS, Gin, and Spring Boot.
- Edge Network Policy Injection: Automatically embeds retry rules, timeout constraints, backoff timing sequences, and rate-limiting tracking headers directly inside output definitions.
- Advanced Pipeline Support: Generates custom components models, explicit file upload formats, and stateful tracking logic profiles for GraphQL networks and WebSocket endpoints.
SKILL.md
Loading
Related Openclaw Skills
Zhihu Search & Content Extractor
An API-driven, token-optimized content extraction skill designed to allow AI agents to search, retrieve, and summarize high-quality Zhihu content without rendering a heavy browser.
browser-act
A powerful browser automation CLI designed for AI agents to interact with web pages, extract dynamic JS content, bypass interactive verification, and handle multi-account sessions locally.
A2A Chat - Agent-to-Agent Realtime Communication
A2A Chat is a lightweight, real-time messaging protocol that enables multiple AI agents to dynamically create chat rooms, collaborate, and exchange data seamlessly.
Browser Act Skill Forge
An AI agent utility that transforms interactive browser-based web exploration, scraping, and action sequences into permanently reusable Openclaw Skills.
Competitor Analysis Assistant
An advanced competitive intelligence agent skill that automates deep product benchmarking, SWOT strategies, and actionable business roadmaps.
Remote Copy Skill
A versatile file transfer tool that enables AI agents to copy directories and files from remote Windows, macOS, or Linux systems to a local Mac via SSH and SCP.
Featured*
