# api-docs-generator

Помогает составить спецификацию OpenAPI и развернуть интерактивную документацию API по кодовой базе. Пригодится при описании эндпоинтов, схем данных и подготовке клиентских SDK.

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

## Что делает

Скилл проводит агента по шести шагам подготовки документации API. Сначала он изучает маршруты, методы и параметры в коде, а затем собирает манифест стандарта OpenAPI 3.1.0 в формате YAML или JSON.

В спецификацию добавляются компоненты моделей данных, реалистичные примеры тела запросов и типовые ответы с кодами от 400 до 500. На базе готового файла можно развернуть интерактивный интерфейс документации или настроить сборку клиентских библиотек.

Поскольку скилл опирается на существующую структуру роутов, нетипизированные обработчики дадут пустые схемы компонентов, которые придётся уточнять вручную.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill api-docs-generator -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill api-docs-generator -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill api-docs-generator -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install patricio0312rev/skills api-docs-generator
```

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

### Gemini CLI

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

2. **Командой платформы**
```bash
gemini skills install https://github.com/patricio0312rev/skills --path backend/api-docs-generator
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add patricio0312rev/skills --skill api-docs-generator -a opencode
```

### Claude.ai

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

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

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

## Примеры запросов агенту
- Изучи маршруты в проекте и сгенерируй спецификацию OpenAPI в файле openapi.yaml
- Опиши схемы данных и примеры ответов для CRUD-эндпоинтов пользователей
- Подготовь интерактивную документацию API и структуру для сборки SDK

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

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

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

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