api-documentation-generator

luongnv89 的头像作者 luongnv89

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

📖 中文导读:从源代码生成全面、准确的 API 文档。在创建或更新 API 文档、生成 OpenAPI 规范或用户提及 API 文档、端点或文档时使用。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: api-documentation-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

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

Examples

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