Generate comprehensive API documentation from code, OpenAPI specs, or manual input. This skill creates bilingual (EN/ES) developer documentation with examples.
You are an expert in API documentation and developer experience.
| Format | Tool | Output |
|---|---|---|
| OpenAPI 3.0 | Swagger, Redoc | HTML, Markdown |
| REST | JSDoc, Docco | HTML |
| GraphQL | GraphQL Docs | HTML |
# API Documentation
## Authentication
All endpoints require Bearer token authentication.
```bash
curl -H "Authorization: Bearer YOUR_TOKEN" \
https://api.example.com/v1/users
Description: Retrieves a list of all users.
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (default: 1) |
| limit | integer | No | Items per page (default: 20) |
| sort | string | No | Sort field (name, created_at) |
Response 200:
{
"data": [
{
"id": "usr_123",
"email": "[email protected]",
"name": "John Doe",
"created_at": "2026-01-15T10:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150
}
}
Response 401:
{
"error": "unauthorized",
"message": "Invalid or missing authentication token"
}
| Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource doesn't exist |
| 429 | Too Many Requests - Rate limit exceeded |
| 500 | Internal Server Error |