api-documentation-generator

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 문서 생성기 스킬

생성 항목

• OpenAPI/Swagger 사양
• API 엔드포인트 문서
• SDK 사용 예시
• 통합 가이드
• 에러 코드 레퍼런스
• 인증 가이드

문서 구조

각 엔드포인트에 대해

## 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": "[e-mail]",
  "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()