# api-documentation

Скилл помогает писать и обновлять справочники API и руководства по интеграции на основе OpenAPI или схем GraphQL.

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

## Что делает

Скилл превращает схемы OpenAPI, аннотации в коде или спецификации GraphQL в прикладную документацию для интеграторов. Он ориентирован на внешних разработчиков и партнёров, которым нужны понятные примеры запросов, форматы ответов, коды ошибок и параметры пагинации.

Работа строится по шагам. Сначала агент определяет один из шести режимов: справочник эндпоинтов, быстрый старт, пошаговый сценарий, руководство по SDK, настройка вебхуков или миграция. Для сверки с реальным поведением кода скилл задействует инструменты `Read`, `Write`, `Edit`, `Glob` и `Grep`, проверяя документацию по фикстурам и тестам.

Скилл строго разграничивает зоны ответственности: он не проектирует эндпоинты (для этого автор рекомендует `api-design`) и не ведёт журнал релизов. Если в репозитории нет надёжного источника правды о поведении API, скилл составляет список нестыковок и пробелов, не пытаясь додумывать контракты.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add akillness/jeo-skills --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 akillness/jeo-skills --skill api-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add akillness/jeo-skills --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 akillness/jeo-skills api-documentation
```

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

### Gemini CLI

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

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

### Windsurf (Devin Desktop)

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

### OpenCode

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

### Claude.ai

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

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

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

## Примеры запросов агенту
- Изучи нашу схему OpenAPI и напиши руководство по первому запуску для внешних разработчиков.
- Обнови справочник вебхуков с учётом проверки подписи и повторной отправки событий.
- Проверь эндпоинты биллинга по тестам и составь список расхождений с текущей документацией.

## Похожие
- [grill-with-docs](https://affpapa.org/nevibecode/skills/grill-with-docs.md) — скилл · 1219756 установок
- [skill-creator](https://affpapa.org/nevibecode/skills/skill-creator.md) — скилл · 414180 установок
- [setup-matt-pocock-skills](https://affpapa.org/nevibecode/skills/setup-matt-pocock-skills.md) — скилл · 1052851 установка
- [handoff](https://affpapa.org/nevibecode/skills/handoff.md) — скилл · 1038491 установка
- [triage](https://affpapa.org/nevibecode/skills/triage.md) — скилл · 990453 установки
- [domain-modeling](https://affpapa.org/nevibecode/skills/domain-modeling.md) — скилл · 876391 установка

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

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

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

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