Claude-howto api-documentation-generator

Генерація вичерпної, точної документації API з вихідного коду. Використовуйте при створенні або оновленні документації API, генерації специфікацій OpenAPI, або коли користувачі згадують документацію API, ендпоінти чи документацію.

install

source · Clone the upstream repo

git clone https://github.com/luongnv89/claude-howto

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/luongnv89/claude-howto "$T" && mkdir -p ~/.claude/skills && cp -r "$T/uk/03-skills/doc-generator" ~/.claude/skills/luongnv89-claude-howto-api-documentation-generator-2fb63f && rm -rf "$T"

manifest: uk/03-skills/doc-generator/SKILL.md

Навичка генерації документації API

Генерує

Специфікації OpenAPI/Swagger
Документацію ендпоінтів API
Приклади використання SDK
Посібники з інтеграції
Довідники кодів помилок
Посібники з автентифікації

Структура документації

Для кожного ендпоінту

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

### Опис
Короткий опис призначення цього ендпоінту

### Параметри

| Назва | Тип | Обовʼязковий | Опис |
|-------|-----|-------------|------|
| id | string | Так | ID користувача |

### Відповідь

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

404 Не знайдено

{
  "error": "USER_NOT_FOUND",
  "message": "Користувач не існує"
}

Приклади

cURL

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

JavaScript

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

Python

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