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

doc-generator

GitHub

从源代码生成全面准确的 API 文档，包括 OpenAPI 规范、端点文档、SDK 示例及集成指南。适用于创建或更新 API 文档、生成规范或在用户提到 API 相关需求时使用。

zh/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/zh/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 文档生成 Skill

可生成内容

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": "User does not exist"
}
```

### 示例

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