Claude-howto api-documentation-generator

从源代码生成全面且准确的 API 文档。适用于创建或更新 API 文档、生成 OpenAPI 规范，或在用户提到 API 文档、端点或说明时使用。

install

source · Clone the upstream repo

git clone https://github.com/luongnv89/claude-howto

Claude Code · Install into ~/.claude/skills/

T=$(mktemp -d) && git clone --depth=1 https://github.com/luongnv89/claude-howto "$T" && mkdir -p ~/.claude/skills && cp -r "$T/zh/03-skills/doc-generator" ~/.claude/skills/luongnv89-claude-howto-api-documentation-generator-62eb22 && rm -rf "$T"

manifest: zh/03-skills/doc-generator/SKILL.md

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 未找到

{
  "error": "USER_NOT_FOUND",
  "message": "User does not exist"
}

示例

cURL

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

JavaScript

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

Python

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