# api-documenter

Скилл для описания REST и GraphQL API в формате OpenAPI/Swagger. Пригодится, когда нужно превратить россыпь эндпоинтов в читаемую спецификацию.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 717 установок · ★ 84
- Автор: zhaono1
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/zhaono1/agent-playbook/tree/HEAD/skills/api-documenter/SKILL.md
- Обновлён: 2026-09-15
- HTML: https://affpapa.org/nevibecode/skills/api-documenter

## Что делает

Скилл включается, когда вы просите задокументировать API, создать спецификацию OpenAPI/Swagger или упоминаете «API docs». Агент получает доступ к `Read`, `Write`, `Edit`, `Bash`, `Grep` и `Glob` — то есть может читать ваш код, искать обработчики и писать файлы спецификации.

Внутри — структура спецификации OpenAPI 3.0.3, требования к описанию эндпоинтов (`summary`, `operationId`, `tags`, `responses`), правила для схем с `$ref`, форматы строк вроде `uuid` и `date-time`, блоки `security` и `securitySchemes` под bearer-токен, а также стандартная схема ошибок и список HTTP-статусов. Есть два скрипта: `python3 scripts/generate_openapi.py --name <resource-name> --output openapi.yaml` собирает спецификацию из кода, `python3 scripts/validate_openapi.py --input openapi.yaml` её проверяет. Для запуска скриптов нужен Python 3.

После завершения скилл вызывает хук `session-logger` в автоматическом режиме, чтобы записать активность по документации. Шаблон спецификации лежит в `references/openapi-template.yaml`, примеры — в `references/examples/`. Если у вас в проекте уже есть свой генератор спецификаций, этот скилл будет писать файлы параллельно — стоит заранее решить, кто из них главный.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-documenter -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-documenter -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-documenter -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install zhaono1/agent-playbook api-documenter
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-documenter -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/zhaono1/agent-playbook --path skills/api-documenter
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add zhaono1/agent-playbook --skill api-documenter -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/zhaono1/agent-playbook/tree/HEAD/skills/api-documenter/SKILL.md

## Когда брать
- собрать спецификацию OpenAPI из существующих обработчиков
- описать параметры и ответы для каждого эндпоинта
- вынести общие схемы в `components` и связать их через `$ref`
- задокументировать bearer-авторизацию и коды ошибок
- проверить готовый `openapi.yaml` на ошибки перед публикацией

## Примеры запросов агенту
- задокументируй REST API в проекте и собери спецификацию OpenAPI
- сгенерируй `openapi.yaml` для ресурса users
- проверь `openapi.yaml` и покажи, где не хватает описаний

## Похожие
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/secondsky-api-reference-documentation.md) — скилл · 454 установки
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 413 установок
- [api-testing-observability-api-documenter](https://affpapa.org/nevibecode/agents/api-testing-observability-api-documenter.md) — субагент · ★ 41729
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [code-documenter](https://affpapa.org/nevibecode/skills/httpsgithubcomjeffallan-code-documenter.md) — скилл · ★ 4676
- [api-design-reviewer](https://affpapa.org/nevibecode/skills/api-design-reviewer.md) — скилл · 768 установок

Из того же набора: [zhaono1/agent-playbook](https://affpapa.org/nevibecode/by/zhaono1/agent-playbook.md) — 18 карточек

_Часть страницы не вошла по размеру — она есть в HTML-версии._

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