# api-documentation-writer

Скилл формирует документацию для REST, GraphQL или gRPC API. Он создаёт спецификации OpenAPI, примеры запросов на нескольких языках и описания ошибок с лимитами.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 368 установок · ★ 382
- Автор: OneWave-AI
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/OneWave-AI/claude-skills/tree/HEAD/api-documentation-writer/SKILL.md
- Обновлён: 2026-10-20
- HTML: https://affpapa.org/nevibecode/skills/api-documentation-writer

## Что делает

Скилл стандартизирует составление технической документации по коду или готовым схемам. Он работает с REST, GraphQL, WebSocket и gRPC. В процесс входит сбор сведений об авторизации (JWT, OAuth, API key), версионировании и адресах эндпоинтов.

Внутри зашиты три файла инструкций. Файл `references/documentation-structure.md` задаёт структуру документа и выносит частые операции вперёд. Шаблон `references/output-template.md` отвечает за разметку Markdown для REST или схему запросов для GraphQL. Перед выдачей результат сверяется с чек-листом качества из `references/best-practices.md`.

Инструкции требуют заменять шаблоны живыми примерами запросов и ответов, а не оставлять плейсхолдеры. Для работы с лимитами нужно сразу расписать коды ошибок, статус `429` и специальные заголовки. Примеры кода генерируются на curl, JavaScript и Python.

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install OneWave-AI/claude-skills api-documentation-writer
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/OneWave-AI/claude-skills --path api-documentation-writer
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add OneWave-AI/claude-skills --skill api-documentation-writer -a opencode
```

### Claude.ai

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

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

## Когда брать
- Описать эндпоинты REST API с реальными примерами запросов и ответов
- Сформировать спецификацию OpenAPI или Swagger по коду сервиса
- Задокументировать схему GraphQL с описанием мутаций и подписок
- Составить руководство по авторизации через JWT, OAuth или API-ключи
- Оформить справочник ошибок с обработкой статуса 429 и лимитов

## Примеры запросов агенту
- Напиши документацию для REST API с примерами на curl и Python
- Создай спецификацию OpenAPI для эндпоинтов авторизации и пользователей
- Задокументируй схему GraphQL с описанием мутаций и подписок

## Похожие
- [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 установок

Из того же набора: [onewave-ai/claude-skills](https://affpapa.org/nevibecode/by/onewave-ai/claude-skills.md) — 95 карточек

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

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