doc-generator · luongnv89 — скилл для Claude Code: документация API из кода
Скилл читает исходники и собирает документацию по эндпоинтам: OpenAPI-спеки, примеры вызовов, коды ошибок. Пригодится, когда API обросло роутами, а README отстал.
npx skills add luongnv89/claude-howto --skill doc-generator -a claude-codeЧто делает 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-code2Вручную: положить файлы
~/.claude/skills/doc-generator/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/doc-generator/
1Через Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill doc-generator -a codex2Вручную: положить файлы
.agents/skills/doc-generator/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill doc-generator -a cursor2Вручную: положить файлы
.cursor/skills/doc-generator/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install luongnv89/claude-howto doc-generator2Вручную: положить файлы
.github/skills/doc-generator/SKILL.md1Через Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill doc-generator -a gemini-cli2Командой платформы
gemini skills install https://github.com/luongnv89/claude-howto --path 03-skills/doc-generatorВручную: положить файлы
.devin/skills/doc-generator/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Через Skills CLI (Vercel)
npx skills add luongnv89/claude-howto --skill doc-generator -a opencodeClaude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в 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 от других авторов.