# api-documenter

Скилл api-documenter для Claude Code собирает спецификации API по коду и комментариям. Формирует документацию при изменении маршрутов или подготовке OpenAPI-документа.

- скилл · `type=skill` · Claude Code, Cursor, Codex, GitHub Copilot, Gemini CLI, Windsurf (Devin Desktop), Claude.ai · ★ 788 у репозитория
- Автор: alirezarezvani
- Лицензия: MIT · policy=mirror · начало файла — в конце страницы
- Исходник: https://github.com/alirezarezvani/claude-code-tresor/tree/HEAD/skills/documentation/api-documenter/SKILL.md
- Обновлён: 2026-07-03
- Проверка безопасности: автоматическая, 2026-11-16 (текст) — признаков вредоносного кода не нашли.
- HTML: https://affpapa.org/nevibecode/skills/alirezarezvani-api-documenter

## Что делает

Скилл анализирует маршруты и комментарии, затем формирует документацию API. Он умеет создавать спецификации OpenAPI 3.0 и Swagger 2.0, а также материалы в форматах API Blueprint и RAML. В документацию могут войти схемы запросов и ответов, требования авторизации, примеры и ошибки.

Скилл распознаёт Express.js, FastAPI, Django REST, Spring Boot, Gin и Rails. Он извлекает сведения из JSDoc, Python docstrings, JavaDoc и комментариев с декораторами; доступные инструменты — Read, Write и Grep. Созданную OpenAPI-спецификацию можно использовать со Swagger UI или импортировать в Postman. Скилл пишет файлы на диск, но сетевой доступ ему не нужен.

Он работает и с включённой песочницей, и без неё. Описания следуют за кодом, поэтому устаревшие комментарии приведут к устаревшей документации. Для пользовательских руководств в исходнике предлагается отдельный субагент `@docs-writer`.

## Установка

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

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

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

### Codex

1. **Через Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -a codex
```

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

### Cursor

1. **Через Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -a cursor
```

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

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install alirezarezvani/claude-code-tresor skills/documentation/api-documenter
```

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

### Gemini CLI

1. **Через Skills CLI (Vercel)**
```bash
npx skills add alirezarezvani/claude-code-tresor --skill api-documenter -a gemini-cli
```

2. **Командой платформы**
```bash
gemini skills install https://github.com/alirezarezvani/claude-code-tresor --path skills/documentation/api-documenter
```

### Windsurf (Devin Desktop)

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

### Claude.ai

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

Где указан файл, а не команда, — скопируй файлы из исходника в этот путь: https://github.com/alirezarezvani/claude-code-tresor/tree/HEAD/skills/documentation/api-documenter/SKILL.md

## Когда брать
- собрать OpenAPI-спецификацию по маршрутам проекта
- описать параметры и ответы API по комментариям в коде
- добавить примеры запросов и типовые ошибки в документацию
- подготовить спецификацию для импорта в Postman

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

## Похожие
- [code-documenter](https://affpapa.org/nevibecode/skills/code-documenter.md) — скилл · 6200 установок
- [api-reference-documentation](https://affpapa.org/nevibecode/skills/api-reference-documentation.md) — скилл · 501 установка
- [doc-api](https://affpapa.org/nevibecode/commands/doc-api.md) — команда · 733 установки
- [hunt-shadow-api](https://affpapa.org/nevibecode/skills/hunt-shadow-api.md) — скилл · ★ 16193 у репозитория
- [api-testing-observability-api-documenter](https://affpapa.org/nevibecode/agents/api-testing-observability-api-documenter.md) — субагент · ★ 42780 у репозитория
- [adding-api-docs](https://affpapa.org/nevibecode/skills/adding-api-docs.md) — скилл · 455 установок

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

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

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

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