К основному содержанию
скилл CX Codex

doc-generator · luongnv89 — скилл для Claude Code: документация API из кода

Скилл читает исходники и собирает документацию по эндпоинтам: OpenAPI-спеки, примеры вызовов, коды ошибок. Пригодится, когда API обросло роутами, а README отстал.

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code
Открыть на GitHub

Что делает doc-generator

Скилл doc-generator разбирает код и выдаёт документацию по каждому эндпоинту. Внутри — шаблон с описанием, таблицей параметров, примерами ответов на успех и на ошибку, а также готовыми вызовами на cURL, JavaScript и Python. Отдельно он берётся за OpenAPI/Swagger-спеки, примеры использования SDK, гайды по интеграции, справочник кодов ошибок и раздел про аутентификацию.

Установка идёт через npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code, файл скилла ложится в ~/.claude/skills/doc-generator/SKILL.md. Тот же репозиторий поддерживает Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode — команды отличаются только флагом платформы. Для GitHub Copilot ставится через gh skill install.

Скилл генерирует текст по вашему коду, поэтому качество описаний зависит от того, насколько аккуратно размечены роуты и схемы. Если в проекте нет типов или валидации запросов, таблицы параметров придётся вычитывать руками — это повод проверить, что скилл вообще смог вытащить из исходников.

Какие задачи решает

  • собрать OpenAPI-спеку по существующим роутам
  • описать параметры и ответы для каждого эндпоинта
  • добавить примеры вызовов на cURL, JavaScript и Python
  • составить справочник кодов ошибок API
  • написать гайд по аутентификации для внешних разработчиков

Примеры запросов агенту

  • сгенерируй документацию по эндпоинтам из папки src/routes
  • собери OpenAPI-спеку для нашего API и добавь примеры ответов
  • обнови справочник кодов ошибок по текущему коду

Как установить doc-generator

1Через Skills CLI (Vercel)

npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code

2Вручную: положить файлы

~/.claude/skills/doc-generator/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/doc-generator/

По шагам, с командами для каждой платформы: Как установить скилл в Claude Code: пять способов

Вопросы о doc-generator

Как установить doc-generator в Claude?

Выполните npx skills add luongnv89/claude-howto --skill doc-generator -a claude-code. Файл скилла появится по пути ~/.claude/skills/doc-generator/SKILL.md.

Что делает doc-generator?

Генерирует документацию API из исходного кода: описания эндпоинтов, параметры, примеры ответов, вызовы на cURL, JavaScript и Python, а также OpenAPI/Swagger-спеки.

С какими платформами работает doc-generator?

Скилл ставится в Claude, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode. Команда установки одна и та же, меняется только флаг платформы.

Исходный текст

SKILL.md · MIT
---
name: doc-generator
description: Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users mention API docs, endpoints, or documentation.
---

# API Documentation Generator Skill

## Generates

- OpenAPI/Swagger specifications
- API endpoint documentation
- SDK usage examples
- Integration guides
- Error code references
- Authentication guides

## Documentation Structure

### For Each Endpoint

````markdown
## GET /api/v1/users/:id

### Description
Brief explanation of what this endpoint does

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |

### Response

**200 Success**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "[email protected]",
  "created_at": "2025-01-15T10:30:00Z"
}
```

**404 Not Found**
```json
{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}
```

### Examples

**cURL**
```bash
curl -X GET "https://api.example.com/api/v1/users/usr_123" \
  -H "Authorization: Bearer YOUR_TOKEN"
```

**JavaScript**
```javascript
const user = await fetch('/api/v1/users/usr_123', {
  headers: { 'Authorization': 'Bearer token' }
}).then(r => r.json());
```

**Python**
```python
response = requests.get(
    'https://api.example.com/api/v1/users/usr_123',
    headers={'Authorization': 'Bearer token'}
)
user = response.json()
```
````

---

**Last Updated**: August 4, 2026
**Claude Code Version**: 2.1.220
**Sources**:
- https://code.claude.com/docs/en/skills
**Compatible Models**: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5

© luongnv89 · MIT · luongnv89/claude-howto

Похожие скиллы

Всё по теме «Тексты и документация» →

Сначала — doc-generator от других авторов.

doc-generator luongnv89 Скилл читает исходники и собирает документацию API: спецификации OpenAPI, описания эндпоинтов, примеры на cURL, JavaScript и Python. CX Codex +1 ★ 45 153звёзд репо documentation-engineer VoltAgent Community Проектирует и обновляет техническую документацию: справочники API, пошаговые руководства и архитектурные схемы. Пригодится, когда документация отстает от изменений в коде. 735установок doc-api davila7 Разбирает код проекта и собирает документацию по API: спецификацию, примеры запросов и ответов, интерактивную страницу. Пригодится, когда эндпоинтов много, а описывать их руками не хочется. 733установок api-documenter zhaono1 Скилл для описания REST и GraphQL API в формате OpenAPI/Swagger. Пригодится, когда нужно превратить россыпь эндпоинтов в читаемую спецификацию. CX Codex +1 717установок api-reference-documentation secondsky Собирает справочник по REST API из спецификации OpenAPI: эндпоинты, авторизация, примеры запросов и ответов. Пригодится, когда нужен developer portal или SDK-референс. CX Codex +1 454установок adding-api-docs spencerpauly Скилл собирает OpenAPI/Swagger-описание вашего API: схемы эндпоинтов, типы запросов и ответов, интерактивную страницу документации. CX Codex +1 413установок scalar codewithmukesh Скилл подсказывает агенту, как подключить Scalar вместо Swagger UI в приложении на .NET 10 и настроить темы, авторизацию и несколько документов. CX Codex +1 2 800установок

Из того же набора7

lesson-quiz Проверяет знание одного урока туториала по Claude: 10 вопросов, разбор каждого ответа и список тем на повторение. CX Codex +1 ★ 45 153звёзд репо doc-generator Скилл читает исходники и собирает документацию API: спецификации OpenAPI, описания эндпоинтов, примеры на cURL, JavaScript и Python. CX Codex +1 ★ 45 153звёзд репо claude-md Создаёт, обновляет или проверяет CLAUDE.md по практикам онбординга ИИ-агента. Полезен, когда файл инструкций разросся и агент перестал его слушать. CX Codex +1 ★ 45 153звёзд репо refactor Ведёт агента через шесть фаз рефакторинга: разбор кода, проверка тестов, поиск code smells, план, пошаговая правка и ревью. CX Codex +1 ★ 45 153звёзд репо claude-md Создаёт, обновляет и проверяет файл CLAUDE.md по правилам, которые помогают агенту быстрее разобраться в проекте. Пригодится, когда инструкции для ИИ разрослись или их ещё нет. CX Codex +1 ★ 45 153звёзд репо brand-voice Скилл держит тексты в одном тоне: маркетинг, письма клиентам, публичные страницы. Полезен, когда над контентом работает несколько человек. CX Codex +1 ★ 45 153звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой