# route-to-openapi

Сканирует определения маршрутов в исходниках и собирает спецификацию OpenAPI 3.0.3. Пригодится, когда документация API нужна, а писать её руками не хочется.

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

## Что делает

Скилл проходит по каталогу с кодом, находит эндпоинты и вытаскивает методы, пути, параметры, тела запросов и модели ответов. Формат параметров приводится к виду `{param}` — `<int:user_id>` из Flask, `:user_id` из Express и Gin превращаются в один и тот же `{user_id}`. Описания берутся из docstring, JSDoc и комментариев, а теги группируются по имени модуля.

Работает через `python scripts/generate_api_doc.py ./src`. Формат вывода задаётся флагом `--format` (`json` или `yaml`), файл — через `--output`, метаданные API — `--title`, `--version`, `--description`, адреса серверов — повторяющимся `--server`. Фреймворк определяется сам, но его можно зафиксировать через `--framework`. Поддержаны Flask, FastAPI, Django REST Framework, Express.js, Gin и Echo.

Нужен Python 3.8 или новее, сторонние библиотеки не требуются — скрипт обходится стандартной библиотекой. Разбор идёт по AST для Python-фреймворков и регулярками для Express, Gin и Echo, поэтому нестандартные обёртки над роутами в спецификацию не попадут. Сканируемый проект должен быть на одном из перечисленных фреймворков.

## Установка

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

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zebbern/claude-code-guide --skill route-to-openapi -a claude-code
```

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zebbern/claude-code-guide --skill route-to-openapi -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zebbern/claude-code-guide --skill route-to-openapi -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install zebbern/claude-code-guide route-to-openapi
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add zebbern/claude-code-guide --skill route-to-openapi -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/zebbern/claude-code-guide --path skills/route-to-openapi
```

### Windsurf (Devin Desktop)

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

### OpenCode

**Через Skills CLI (Vercel)**
```bash
npx skills add zebbern/claude-code-guide --skill route-to-openapi -a opencode
```

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/zebbern/claude-code-guide/tree/HEAD/skills/route-to-openapi/SKILL.md

## Когда брать
- собрать спецификацию OpenAPI из уже написанных маршрутов
- вытащить список эндпоинтов и их параметров из чужого репозитория
- привести пути Flask и Express к единому формату `{param}`
- подготовить файл для импорта в Swagger UI или Redoc
- обновить документацию API после переименования роутов

## Примеры запросов агенту
- Просканируй `./src` и собери спецификацию OpenAPI в `api-spec.yaml`
- Сгенерируй документацию по маршрутам Flask с заголовком «My API» и версией 2.0.0
- Найди все эндпоинты в `./routes` и добавь сервер `http://localhost:3000`

## Похожие
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 413 установок
- [openapi-generator](https://affpapa.org/nevibecode/skills/openapi-generator.md) — скилл · 306 установок
- [api-documenter](https://affpapa.org/nevibecode/skills/api-documenter.md) — скилл · 717 установок
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/secondsky-api-reference-documentation.md) — скилл · 454 установки
- [spring-boot-openapi-documentation](https://affpapa.org/nevibecode/skills/spring-boot-openapi-documentation.md) — скилл · 4000 установок
- [doc-generator](https://affpapa.org/nevibecode/skills/luongnv89-doc-generator.md) — скилл · ★ 45376

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

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

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