api-documentation-generator

Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.

Stars 16,343

Forks 1,898

Install this agent skill to your Project

npx add-skill https://github.com/luongnv89/claude-howto/tree/main/03-skills/doc-generator

SKILL.md

API Documentation Generator Skill

Generates

OpenAPI/Swagger specifications
API endpoint documentation
SDK usage examples
Integration guides
Error code references
Authentication guides

Documentation Structure

For Each Endpoint

markdown

## GET /api/v1/users/:id

### Description
Brief explanation of what this endpoint does

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

### Response

**200 Success**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2025-01-15T10:30:00Z"
}

404 Not Found

json

{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}

Examples

cURL

bash

curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

javascript

const user = await fetch('/api/v1/users/usr_123', {
  headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());

Python

python

response = requests.get(
    'https://api.example.com/api/v1/users/usr_123',
    headers={'Authorization': 'Bearer token'}
)
user = response.json()

Search AI Tools

api-documentation-generator

Install this agent skill to your Project

SKILL.md

API Documentation Generator Skill

Generates

Documentation Structure

For Each Endpoint

Examples

Recommended Agent Skills

self-assessment

lesson-quiz

brand-voice-consistency

code-review-specialist

claude-md

code-refactor