api-documentation

Creates comprehensive API documentation including OpenAPI specs, reference guides, tutorials, and Postman collections. Makes your API developer-friendly.

3,891 stars

Best use case

api-documentation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Creates comprehensive API documentation including OpenAPI specs, reference guides, tutorials, and Postman collections. Makes your API developer-friendly.

Teams using api-documentation should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/api-documentation/SKILL.md --create-dirs "https://raw.githubusercontent.com/openclaw/skills/main/skills/1477009639zw-blip/api-documentation/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/api-documentation/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How api-documentation Compares

Feature / Agentapi-documentationStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Creates comprehensive API documentation including OpenAPI specs, reference guides, tutorials, and Postman collections. Makes your API developer-friendly.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

# API Documentation Service

## What You Get

### OpenAPI 3.0 Specification
- Complete paths and operations
- Request/response schemas
- Authentication documentation
- Error codes and descriptions
- Examples for every endpoint

### Developer Guide
- Getting started tutorial
- Authentication setup
- Code examples in 5+ languages
- SDK installation guides
- Rate limiting documentation

### Reference Manual
- Alphabetical endpoint reference
- Request/response field descriptions
- Data types and formats
- Pagination and filtering

### Postman Collection
- Ready-to-use requests
- Environment variables
- Test scripts
- Auto-generated from OpenAPI

## Pricing

| Type | Endpoints | Turnaround | Price |
|------|-----------|-----------|-------|
| Simple API | 5-10 | 2 days | $100 |
| Medium API | 10-30 | 4 days | $300 |
| Complex API | 30+ | 7 days | $800 |

## Tools

- Swagger/OpenAPI 3.0
- Stoplight Elements
- Redoc
- Postman
- Docusaurus

Related Skills

API Documentation Generator

3891
from openclaw/skills

Generate production-ready API documentation from endpoint descriptions. Outputs OpenAPI 3.0, markdown reference docs, and SDK quickstart guides.

Coding & Development

name: Snipara MCP - Smart Documentation Search

3891
from openclaw/skills

description: Find answers in your codebase 10x faster with semantic search. Query multiple repos at once. AI remembers your preferences across sessions.

quality-documentation-manager

3891
from openclaw/skills

Document control system management for medical device QMS. Covers document numbering, version control, change management, and 21 CFR Part 11 compliance. Use for document control procedures, change control workflow, document numbering, version management, electronic signature compliance, or regulatory documentation review.

Technical Documentation Engine

3891
from openclaw/skills

Complete technical documentation system — from planning through maintenance. Covers READMEs, API docs, guides, architecture docs, runbooks, and developer portals. Includes templates, quality scoring, and automation.

---

3891
from openclaw/skills

name: article-factory-wechat

Content & Documentation

humanizer

3891
from openclaw/skills

Remove signs of AI-generated writing from text. Use when editing or reviewing text to make it sound more natural and human-written. Based on Wikipedia's comprehensive "Signs of AI writing" guide. Detects and fixes patterns including: inflated symbolism, promotional language, superficial -ing analyses, vague attributions, em dash overuse, rule of three, AI vocabulary words, negative parallelisms, and excessive conjunctive phrases.

Content & Documentation

find-skills

3891
from openclaw/skills

Helps users discover and install agent skills when they ask questions like "how do I do X", "find a skill for X", "is there a skill that can...", or express interest in extending capabilities. This skill should be used when the user is looking for functionality that might exist as an installable skill.

General Utilities

tavily-search

3891
from openclaw/skills

Use Tavily API for real-time web search and content extraction. Use when: user needs real-time web search results, research, or current information from the web. Requires Tavily API key.

Data & Research

baidu-search

3891
from openclaw/skills

Search the web using Baidu AI Search Engine (BDSE). Use for live information, documentation, or research topics.

Data & Research

agent-autonomy-kit

3891
from openclaw/skills

Stop waiting for prompts. Keep working.

Workflow & Productivity

Meeting Prep

3891
from openclaw/skills

Never walk into a meeting unprepared again. Your agent researches all attendees before calendar events—pulling LinkedIn profiles, recent company news, mutual connections, and conversation starters. Generates a briefing doc with talking points, icebreakers, and context so you show up informed and confident. Triggered automatically before meetings or on-demand. Configure research depth, advance timing, and output format. Walking into meetings blind is amateur hour—missed connections, generic small talk, zero leverage. Use when setting up meeting intelligence, researching specific attendees, generating pre-meeting briefs, or automating your prep workflow.

Workflow & Productivity

self-improvement

3891
from openclaw/skills

Captures learnings, errors, and corrections to enable continuous improvement. Use when: (1) A command or operation fails unexpectedly, (2) User corrects Claude ('No, that's wrong...', 'Actually...'), (3) User requests a capability that doesn't exist, (4) An external API or tool fails, (5) Claude realizes its knowledge is outdated or incorrect, (6) A better approach is discovered for a recurring task. Also review learnings before major tasks.

Agent Intelligence & Learning