# generate-swagger-docs

Скилл generate-swagger-docs для Claude Code сканирует кодовую базу, находит REST-эндпоинты и создаёт спецификацию OpenAPI и интерактивную HTML-документацию. Документирует API.

- скилл · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 260 установок · ★ 50 у репозитория
- Автор: qodex-ai
- Лицензия: не указана · policy=link-only · показываем только описание, файл — у автора
- Исходник: https://github.com/qodex-ai/ai-agent-skills/tree/HEAD/skills/generate-swagger-docs/SKILL.md
- Обновлён: 2026-01-05
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/generate-swagger-docs

## Что делает

Скилл анализирует репозиторий, определяет веб-фреймворк и собирает описание найденных API-эндпоинтов. На выходе появляются OpenAPI 3.0 в `apimesh/swagger.json` и автономная HTML-документация в `apimesh/apimesh-docs.html`, которую можно открыть или передать коллегам.

Внутри используется скрипт-обёртка, который принимает ключ, подготавливает каталог `apimesh` и запускает инструмент `apimesh`. Поддерживаются Django, Flask, FastAPI, Express, NestJS, Rails и Go. Фреймворк можно определить автоматически или задать вручную.

Для анализа нужен ключ OpenAI. Настройки сохраняются в `apimesh/config.json`, поэтому этот файл нужно добавить в `.gitignore`: в нём могут находиться секреты. Без ключа OpenAI генерация документации не запустится.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install qodex-ai/ai-agent-skills skills/generate-swagger-docs
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/qodex-ai/ai-agent-skills --path skills/generate-swagger-docs
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add qodex-ai/ai-agent-skills --skill generate-swagger-docs -a opencode
```

### Claude.ai

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

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

## Когда брать
- найти API-эндпоинты в репозитории
- собрать OpenAPI 3.0-спеку
- создать интерактивную HTML-документацию
- определить веб-фреймворк проекта
- сохранить настройки запуска в `apimesh/config.json`

## Примеры запросов агенту
- Проанализируй репозиторий и создай документацию для всех API-эндпоинтов.
- Собери OpenAPI-спеку проекта в `apimesh/swagger.json` и HTML-документацию рядом с ней.
- Определи фреймворк API и запусти генерацию через `generate-with-key.sh` с моим ключом OpenAI.

## Похожие
- [generate-api-documentation](https://affpapa.org/nevibecode/commands/generate-api-documentation.md) — команда · 1849 установок
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 455 установок
- [api-docs-generator](https://affpapa.org/nevibecode/skills/api-docs-generator.md) — скилл · 411 установок
- [api-docs](https://affpapa.org/nevibecode/agents/api-docs.md) — субагент · ★ 850 у репозитория
- [golang-swagger](https://affpapa.org/nevibecode/skills/golang-swagger.md) — скилл · 39200 установок
- [swagger-doc-creator](https://affpapa.org/nevibecode/skills/swagger-doc-creator.md) — скилл · 239 установок

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

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