API Documentation Generator

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

514 stars 146 forksSoftware Development

Install

skills CLI (Claude Code, Cursor, Codex and more)
npx skills add Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documentation-generator
Manual install
git clone --depth 1 https://github.com/Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI.git /tmp/Agent-Skills-4-Vibe-Coding-CLI
mkdir -p ~/.claude/skills
cp -r /tmp/Agent-Skills-4-Vibe-Coding-CLI/.agent/skills/api-documentation-generator ~/.claude/skills/api-documentation-generator

Personal skills live in ~/.claude/skills. Use .claude/skills in a project folder to share a skill with your team.

From the SKILL.md

# API Documentation Generator

## Overview

Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines.

Perfect for REST APIs, GraphQL APIs, and WebSocket APIs.

## When to Use This Skill

- Use when you need to document a new API
- Use when updating existing API documentation
- Use when your API lacks clear documentation
- Use when onboarding new developers to your API
- Use when preparing API documentation for external users
- Use when creating OpenAPI/Swagger specifications

## How It Works

## 🧠 Knowledge Modules (Fractal Skills)

### 1. [Step 1: Analyze the API Structure](./sub-skills/step-1-analyze-the-api-structure.md)
### 2. [Step 2: Generate Endpoint Documentation](./sub-skills/step-2-generate-endpoint-documentation.md)
### 3. [Step 3: Add Usage Guidelines](./sub-skills/step-3-add-usage-guidelines.md)
### 4. [Step 4: Document Error Handling](./sub-skills/step-4-document-error-handling.md)
### 5. [Step 5: Create Interactive Examples](./sub-skills/step-5-create-interactive-examples.md)
### 6. [Example 1: REST API Endpoint Documentation](./sub-skills/example-1-rest-api-endpoint-documentation.md)
### 7. [Example 2: GraphQL API Documentation](./sub-skills/example-2-graphql-api-documentation.md)
Read the full skill on GitHub

Details

Skill name
api-documentation-generator
Path
.agent/skills/api-documentation-generator/SKILL.md
Repo updated
11 June 2026
Copies
Found in 4 GitHub repos

FAQ

What does the API Documentation Generator skill do?

Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices

How do I install the API Documentation Generator skill?

skills CLI (Claude Code, Cursor, Codex and more): npx skills add Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI --skill api-documentation-generator. Skills go in ~/.claude/skills (personal) or .claude/skills (project), and Claude loads them automatically when a task matches the description.

Is API Documentation Generator popular?

It lives in Dokhacgiakhoa/Agent-Skills-4-Vibe-Coding-CLI, which has 514 GitHub stars and 146 forks.

Related skills

Browse the most popular Claude skills, all software development skills, or write your own with the skills generator.