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

doc-generator

GitHub

从源代码生成全面准确的API文档，包括OpenAPI规范、端点文档、SDK示例及集成指南。适用于创建或更新API文档、生成OpenAPI规范等场景。

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

Trigger Scenarios

用户提到需要生成或更新API文档用户请求生成OpenAPI规范或Swagger文件用户提及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/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": "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

## 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": "john@example.com",
  "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