# api-reference-documentation

Скилл помогает агенту собрать справочник по API: эндпоинты, аутентификация, примеры запросов и ответов, спецификация OpenAPI.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 494 установки · ★ 371
- Автор: aj-geddes
- Лицензия: MIT · policy=mirror · лицензия открытая, файл — в исходнике
- Исходник: https://github.com/aj-geddes/useful-ai-prompts/tree/HEAD/skills/api-reference-documentation/SKILL.md
- Обновлён: 2026-03-04
- HTML: https://affpapa.org/nevibecode/skills/api-reference-documentation

## Что делает

Скилл задаёт агенту структуру работы над документацией API. Он ведёт от спецификации OpenAPI 3.0+ к описанию эндпоинтов, аутентификации, примеров запросов и ответов, лимитов и пагинации. Внутри есть стартовый пример спецификации и каталог `references/` с подробными разборами — например, спецификация OpenAPI и описание эндпоинта списка товаров.

Помимо REST, скилл покрывает GraphQL, вебхуки, версионирование API и документацию SDK. Отдельный блок best practices перечисляет, что стоит включать: примеры ответов с ошибками, единые имена полей, примеры на нескольких языках, интерактивный Swagger UI. Там же список того, чего делать не надо — оставлять эндпоинты без описания, забывать про аутентификацию, игнорировать пометки об устаревании.

Скилл рассчитан на несколько платформ: Claude, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode. Для Claude файл скилла лежит по пути `~/.claude/skills/api-reference-documentation/SKILL.md`. Если у вас уже есть рабочая спецификация, скилл пригодится для её приведения к единому виду — но сначала проверьте, что версия OpenAPI в проекте не ниже 3.0, иначе часть примеров придётся переписывать.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-reference-documentation -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-reference-documentation -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-reference-documentation -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install aj-geddes/useful-ai-prompts api-reference-documentation
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-reference-documentation -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/aj-geddes/useful-ai-prompts --path skills/api-reference-documentation
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add aj-geddes/useful-ai-prompts --skill api-reference-documentation -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Собери справочник по API для нашего сервиса заказов: эндпоинты, аутентификация, примеры запросов и ответов.
- Оформи спецификацию OpenAPI для этих эндпоинтов и добавь примеры ответов с ошибками.
- Задокументируй вебхуки и распиши, как менять версию API без ломающих изменений.

## Похожие
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [api-documentation](https://affpapa.org/nevibecode/skills/bobmatnyc-api-documentation.md) — скилл · 379 установок
- [spring-boot-openapi-documentation](https://affpapa.org/nevibecode/skills/spring-boot-openapi-documentation.md) — скилл · 4000 установок
- [documentation-engineer](https://affpapa.org/nevibecode/agents/documentation-engineer.md) — субагент · 735 установок
- [api-reference-quality](https://affpapa.org/nevibecode/skills/api-reference-quality.md) — скилл · 7800 установок

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

Из того же набора: [aj-geddes/useful-ai-prompts](https://affpapa.org/nevibecode/by/aj-geddes/useful-ai-prompts.md) — 118 карточек

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