luongnv89

doc-generator

Generates comprehensive API documentation from source code including OpenAPI specs, endpoint documentation, and SDK examples. Use when creating or updating API docs.

luongnv89 44.050 5.457 Actualitzat fa 2 mesos

Recursos

1
GitHub

Instal·la

npx skillscat add luongnv89/claude-howto/api-documentation-generator

Instal·la des del registre de SkillsCat.

Sobre aquest skill

Generates comprehensive API documentation from source code including OpenAPI specs, endpoint documentation, and SDK examples. Use when creating or updating API docs.

SKILL.md

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: