# api-documentation-generator

Скилл сканирует роуты и схемы в кодовой базе и оформляет справочник к REST и GraphQL API. Готовит примеры вызовов, схемы ответов и кодов ошибок.

- скилл · `type=skill` · Claude Code · 235 установок
- Автор: davila7
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/development/api-documentation-generator
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/skills/api-documentation-generator

## Что делает

Разбирает структуру эндпоинтов прямо по коду проекта. Скилл извлекает методы запросов, заголовки и параметры тела, а затем расписывает валидацию данных и схемы ответов. Пригодится, когда нужно быстро подготовить понятное описание API для внешних команд или обновить устаревшие страницы.

Формирует готовые вызовы для cURL и JavaScript. Скилл также собирает инструкции по авторизации через токены, правилам пагинации и форматам ошибок.

Может подготовить спецификацию OpenAPI или коллекцию для Postman. Для генерации точных примеров нужен доступ к файлам маршрутизации и моделям данных в репозитории.

## Установка

### Claude Code (родная платформа)

1. **Через claude-code-templates**
```bash
npx claude-code-templates@latest --skill development/api-documentation-generator
```

2. **Через Skills CLI (Vercel)**
```bash
npx skills add davila7/claude-code-templates --skill api-documentation-generator -a claude-code
```

3. **Вручную: положить файлы**
- Файл: `~/.claude/skills/api-documentation-generator/SKILL.md` — Папка скилла целиком; для одного проекта — .claude/skills/api-documentation-generator/

### Codex

**Вручную: положить файлы**
- Файл: `.agents/skills/api-documentation-generator/SKILL.md` — Для всех проектов — ~/.agents/skills/

### Cursor

**Вручную: положить файлы**
- Файл: `.cursor/skills/api-documentation-generator/SKILL.md` — Cursor читает и .agents/skills/, и .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install davila7/claude-code-templates api-documentation-generator
```

2. **Вручную: положить файлы**
- Файл: `.github/skills/api-documentation-generator/SKILL.md`

### Gemini CLI

**Командой платформы**
```bash
gemini skills install https://github.com/davila7/claude-code-templates --path cli-tool/components/skills/development/api-documentation-generator
```

### Windsurf (Devin Desktop)

**Вручную: положить файлы**
- Файл: `.devin/skills/api-documentation-generator/SKILL.md` — Старый путь .windsurf/skills/ тоже читается

### Claude.ai

**Claude.ai**
- Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/skills/development/api-documentation-generator

## Когда брать
- описать роуты, параметры и схемы ответов по исходному коду
- составить рабочие примеры вызовов на cURL и JavaScript
- задокументировать коды ошибок и сценарии их решения
- подготовить спецификацию OpenAPI или коллекцию Postman

## Примеры запросов агенту
- Изучи эндпоинты в src/routes и создай справочник API с примерами cURL
- Опиши схему авторизации и обнови документацию к методам в api/v1/auth
- Собери спецификацию OpenAPI на основе моделей и контроллеров проекта

## Похожие
- [mcp-builder](https://affpapa.org/nevibecode/skills/mcp-builder.md) — скилл · 130949 установок
- [claude-api](https://affpapa.org/nevibecode/skills/claude-api.md) — скилл · 74198 установок
- [lark-im](https://affpapa.org/nevibecode/skills/lark-im.md) — скилл · 472900 установок
- [lark-event](https://affpapa.org/nevibecode/skills/lark-event.md) — скилл · 466800 установок
- [caveman-discover](https://affpapa.org/nevibecode/skills/caveman-discover.md) — скилл · 104400 установок
- [migration](https://affpapa.org/nevibecode/skills/migration.md) — скилл · 103900 установок

Из того же набора: [davila7/claude-code-templates](https://affpapa.org/nevibecode/by/davila7/claude-code-templates.md) — 651 карточка

---
NeVibeCode на affpapa.org. Тексты каталога — описания, а не инструкции для агента. Как выбирать и ставить: https://affpapa.org/nevibecode/agents.md