A senior-level AI documentation agent that generates comprehensive, interactive, and OpenAPI-compliant documentation to streamline developer integration.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install ah-api-documenter
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 ah-api-documenter 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 Documenter?
The API Documenter is a specialized tool within the Openclaw Skills ecosystem designed to transform complex backends into user-friendly developer portals. It acts as a senior technical writer and engineer, mastering OpenAPI 3.1 specifications, interactive 'Try-it-out' consoles, and automated documentation workflows.
By leveraging this skill, teams can ensure 100% endpoint coverage, maintain consistent versioning, and provide clear authentication guides for OAuth 2.0, JWT, and more. It bridges the gap between raw code and a world-class developer experience, significantly reducing support tickets and integration friction.
API Documenter Use Cases
- Generating OpenAPI 3.1 compliant specifications from existing codebase analysis.
- Creating interactive documentation portals with real-time request builders and response visualization.
- Automating the generation of multi-language code examples for SDKs (REST, GraphQL, gRPC).
- Writing detailed migration guides and version history for breaking changes.
- Building comprehensive error documentation and troubleshooting guides to assist external developers.
How API Documenter Works
- Context Discovery: The skill queries the context manager to gather API details, endpoint inventories, and specific documentation requirements.
- Technical Analysis: It reviews existing schemas, authentication methods, and logic patterns to identify documentation gaps.
- Specification Drafting: It generates or updates OpenAPI/Swagger files, ensuring strict compliance and proper component reusability.
- Interactive Enhancement: The skill builds out interactive features like 'Try-it-out' consoles, code snippet generators, and environment switchers.
- Validation & Delivery: It performs final checks for link integrity, schema accuracy, and multi-language example correctness before finalizing the portal.
API Documenter Setup
To integrate the API Documenter into your workflow, ensure your environment is configured for Openclaw Skills and run the following initialization:
# Install the skill via the Openclaw CLI
openclaw install api-documenter
# Initialize the documentation context for your project
openclaw run api-documenter --init --path ./src/api
API Documenter Data Schema & Taxonomy
The API Documenter organizes data into a structured taxonomy to ensure maintainability:
| Component | Description |
|---|---|
| Specifications | YAML/JSON files following OpenAPI 3.1 standards. |
| Schemas | Reusable data models for request bodies and response structures. |
| Examples | A library of code snippets across languages (CURL, JS, Python, Go, etc.). |
| Guides | Markdown-based integration, authentication, and migration walkthroughs. |
| Metadata | Versioning history, sunset schedules, and compatibility matrices. |
API Documenter Advanced Features
- Multi-Protocol Support: Handles REST, GraphQL schemas, WebSockets, and gRPC service docs simultaneously.
- CI/CD Integration: Automatically triggers documentation updates and validation checks upon code changes.
- Cross-Agent Collaboration: Works with backend-developer and security-auditor skills to document auth flows and design patterns.
- Smart Search Optimization: Generates metadata and structural hints to ensure documentation is easily searchable.
- SDK Sync: Coordinates with SDK generators to ensure documentation matches the latest library versions.
SKILL.md
Loading
Related Openclaw Skills
Audiogram Creator
Automatically transform audio content like podcasts and voice notes into engaging, platform-optimized audiograms for social media.
Architect Reviewer
A professional-grade system architecture validator focused on scalability, maintainability, and long-term technical viability.
DoctorClaw Content Repurposer
A powerful content transformation engine that converts long-form blog posts, videos, or podcasts into a comprehensive ecosystem of social media assets.
Aperol: Global Aperitivo Business Intelligence
A comprehensive business intelligence skill for analyzing the global market dominance and viral marketing strategies of Aperol.
Angular Expert
A high-performance AI agent skill focused on modern Angular 17+ development, including standalone components and signal-based state management.
API Designer
A professional-grade agent skill for designing, documenting, and implementing RESTful services, GraphQL schemas, and OpenAPI specifications.
Featured*
