Agent Skills › luongnv89/claude-howto › doc-generator

doc-generator

GitHub

用于从源代码生成全面准确的 API 文档，包括 OpenAPI 规范、端点文档、SDK 示例及错误码参考。

uk/03-skills/doc-generator/SKILL.md luongnv89/claude-howto

Trigger Scenarios

创建或更新 API 文档生成 OpenAPI 规范提及 API 文档或端点

Install

npx skills add luongnv89/claude-howto --skill doc-generator -g -y

More Options

Non-standard path

npx skills add https://github.com/luongnv89/claude-howto/tree/main/uk/03-skills/doc-generator -g -y

Use without installing

npx skills use luongnv89/claude-howto@doc-generator

指定 Agent (Claude Code)

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

安装 repo 全部 skill

npx skills add luongnv89/claude-howto --all -g -y

预览 repo 内 skill

npx skills add luongnv89/claude-howto --list

SKILL.md

Frontmatter

{
    "name": "doc-generator",
    "description": "Генерація вичерпної, точної документації API з вихідного коду. Використовуйте при створенні або оновленні документації API, генерації специфікацій OpenAPI, або коли користувачі згадують документацію API, ендпоінти чи документацію."
}

Навичка генерації документації API

Генерує

Специфікації OpenAPI/Swagger
Документацію ендпоінтів API
Приклади використання SDK
Посібники з інтеграції
Довідники кодів помилок
Посібники з автентифікації

Структура документації

Для кожного ендпоінту

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

### Опис
Короткий опис призначення цього ендпоінту

### Параметри

| Назва | Тип | Обовʼязковий | Опис |
|-------|-----|-------------|------|
| id | string | Так | ID користувача |

### Відповідь

**200 Успіх**
```json
{
  "id": "usr_123",
  "name": "John Doe",
  "email": "john@example.com",
  "created_at": "2025-01-15T10:30:00Z"
}
```

**404 Не знайдено**
```json
{
  "error": "USER_NOT_FOUND",
  "message": "Користувач не існує"
}
```

### Приклади

**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()
```