Api Documentation Generator

---
version: 4.1.0-fractal
name: api-documentation-generator
description: "Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices"
---

# 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)
### 8. [Example 3: Authentication Documentation](./sub-skills/example-3-authentication-documentation.md)
### 9. [Getting a Token](./sub-skills/getting-a-token.md)
### 10. [Using the Token](./sub-skills/using-the-token.md)
### 11. [Token Expiration](./sub-skills/token-expiration.md)
### 12. [✅ Do This](./sub-skills/do-this.md)
### 13. [❌ Don't Do This](./sub-skills/dont-do-this.md)
### 14. [Recommended Sections](./sub-skills/recommended-sections.md)
### 15. [Problem: Documentation Gets Out of Sync](./sub-skills/problem-documentation-gets-out-of-sync.md)
### 16. [Problem: Missing Error Documentation](./sub-skills/problem-missing-error-documentation.md)
### 17. [Problem: Examples Don't Work](./sub-skills/problem-examples-dont-work.md)
### 18. [Problem: Unclear Parameter Requirements](./sub-skills/problem-unclear-parameter-requirements.md)
### 19. [OpenAPI/Swagger](./sub-skills/openapiswagger.md)
### 20. [Postman Collection](./sub-skills/postman-collection.md)