# generate-api-documentation

Анализирует код эндпоинтов, находит аннотации и генерирует спецификации OpenAPI, Swagger UI или Redoc. Помогает настроить сборку документации API и шаги в CI/CD.

- команда · `type=command` · Claude Code · 1849 установок
- Автор: davila7
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/commands/documentation/generate-api-documentation.md
- Обновлён: 2026-10-24
- HTML: https://affpapa.org/nevibecode/commands/generate-api-documentation

## Что делает

Команда проверяет кодовую базу на наличие аннотаций вроде `@api`, `@swagger` или `@doc`, а также ищет существующие файлы спецификаций YAML и JSON. Затем Claude Code определяет фреймворк через `package.json` и предлагает подходящий инструмент: Swagger UI, Redoc, Postman или Insomnia.

Процесс разбит на десять этапов. Агент размечает схемы запросов и ответов, добавляет примеры вызовов и настраивает шаги генерации в `.github/workflows/`. Документацию можно собрать сразу в нескольких форматах, например в HTML или Markdown.

Команде обязательно нужны разрешения Bash, Read, Write и Edit. Без доступа к терминалу агент не сможет запустить поиск файлов через `grep` и `find`.

## Установка

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

1. **Через claude-code-templates**
```bash
npx claude-code-templates@latest --command documentation/generate-api-documentation
```

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

### Codex

**Вручную: положить файлы**
- Файл: `~/.codex/prompts/generate-api-documentation.md` — Вызов — /prompts:generate-api-documentation. В Codex этот формат помечен устаревшим, замена — скиллы

### GitHub Copilot

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

### Gemini CLI

**Вручную: положить файлы**
- Файл: `.gemini/commands/generate-api-documentation.toml` — Gemini хранит команды в TOML: текст запроса — в поле prompt

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/davila7/claude-code-templates/tree/HEAD/cli-tool/components/commands/documentation/generate-api-documentation.md

## Когда брать
- найти эндпоинты и служебные аннотации в коде проекта
- сгенерировать спецификации OpenAPI и Swagger из исходников
- развернуть интерактивную документацию на Redoc или Swagger UI
- подготовить коллекции запросов для Postman и Insomnia
- встроить автоматическую сборку документации в CI/CD

## Примеры запросов агенту
- Сгенерируй интерактивную документацию Swagger UI для REST API: `/generate-api-documentation --swagger-ui`
- Собери документацию для эндпоинтов в формате Redoc: `/generate-api-documentation --redoc`
- Экспортируй спецификации API сразу в нескольких форматах: `/generate-api-documentation --multi-format`

## Похожие
- [revise-claude-md](https://affpapa.org/nevibecode/commands/revise-claude-md.md) — команда · ★ 44635
- [setup](https://affpapa.org/nevibecode/commands/pranay-yadav-setup.md) — команда · ★ 41729

Из того же набора: [davila7/claude-code-templates](https://affpapa.org/nevibecode/by/davila7/claude-code-templates.md) — 238 карточек

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

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