# api-documentation

Скилл api-documentation задаёт шаблоны для документации REST и GraphQL API. Он пригодится для описания эндпоинтов, схем, ошибок и примеров SDK.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 1 установка · ★ 8 у репозитория
- Автор: bradtaylorsf
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/bradtaylorsf/alphaagent-team/tree/HEAD/plugins/aai-docs/skills/api-documentation/SKILL.md
- Обновлён: 2026-02-05
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/bradtaylorsf-api-documentation

## Что делает

Скилл задаёт структуру документации REST API: метод и путь, авторизацию, параметры, тело запроса, успешный ответ и ошибки. Отдельные разделы описывают Bearer token, API key и OAuth 2.0, а также обычную и cursor-based пагинацию с примерами параметров и ответов.

Для GraphQL он предлагает документировать типы, input-типы, queries и mutations вместе с аргументами, примерами запросов и ответов. В наборе есть примеры SDK для JavaScript/TypeScript, Python и cURL. Ошибки оформляются через единый JSON с кодом, сообщением, деталями и `requestId`.

Скилл связан с субагентом `api-doc-writer`. Он рассчитан именно на REST и GraphQL, поэтому описание других API-стилей этим набором шаблонов не покрывается.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bradtaylorsf/alphaagent-team --skill api-documentation -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bradtaylorsf/alphaagent-team --skill api-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bradtaylorsf/alphaagent-team --skill api-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install bradtaylorsf/alphaagent-team plugins/aai-docs/skills/api-documentation
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add bradtaylorsf/alphaagent-team --skill api-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/bradtaylorsf/alphaagent-team --path plugins/aai-docs/skills/api-documentation
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add bradtaylorsf/alphaagent-team --skill api-documentation -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/bradtaylorsf/alphaagent-team/tree/HEAD/plugins/aai-docs/skills/api-documentation/SKILL.md

## Когда брать
- описать REST-эндпоинт с параметрами и ответами
- зафиксировать способы авторизации API
- оформить постраничную и cursor-based пагинацию
- задокументировать GraphQL queries и mutations
- добавить примеры SDK для JavaScript/TypeScript, Python и cURL

## Примеры запросов агенту
- Оформи документацию REST-эндпоинта `/api/v1/users/:id` с параметрами, авторизацией, ответами и ошибками.
- Опиши GraphQL mutation `createUser`: добавь input, успешный ответ и ошибки.
- Добавь к документации API примеры вызовов на Python и cURL, а также раздел о пагинации.

## Похожие
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/api-reference-documentation.md) — скилл · 501 установка
- [api-documentation-generator](https://affpapa.org/nevibecode/skills/api-documentation-generator.md) — скилл · 235 установок
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [api-documentation-writer](https://affpapa.org/nevibecode/skills/api-documentation-writer.md) — скилл · 389 установок
- [api-integration-specialist](https://affpapa.org/nevibecode/plugins/api-integration-specialist.md) — плагин · ★ 1013 у репозитория
- [api-versioning-policy](https://affpapa.org/nevibecode/skills/api-versioning-policy.md) — скилл · 10100 установок

## Другие версии с тем же именем
- [api-documentation · bobmatnyc](https://affpapa.org/nevibecode/skills/bobmatnyc-api-documentation.md) — 397 установок
- [api-documentation · akillness](https://affpapa.org/nevibecode/skills/api-documentation.md) — 385 установок

Из того же набора: [bradtaylorsf/alphaagent-team](https://affpapa.org/nevibecode/by/bradtaylorsf/alphaagent-team.md) — 2 карточки

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

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