File size: 3,002 Bytes
93e7af1 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | // API Documentation
export const API_DOCS_MD = String.raw`
# REST API Documentation
## 🔐 Authentication
All API requests require authentication using **Bearer tokens**. Include your API key in the Authorization header:
${'```'}http
GET /api/v1/users
Host: api.example.com
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
${'```'}
## 📍 Endpoints
### Users API
#### **GET** /api/v1/users
Retrieve a paginated list of users.
**Query Parameters:**
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| page | integer | 1 | Page number |
| limit | integer | 20 | Items per page |
| sort | string | "created_at" | Sort field |
| order | string | "desc" | Sort order |
**Response:** 200 OK
${'```'}json
{
"data": [
{
"id": "usr_1234567890",
"email": "user@example.com",
"name": "John Doe",
"role": "admin",
"created_at": "2024-01-15T10:30:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 156,
"pages": 8
}
}
${'```'}
#### **POST** /api/v1/users
Create a new user account.
**Request Body:**
${'```'}json
{
"email": "newuser@example.com",
"password": "SecurePassword123!",
"name": "Jane Smith",
"role": "user"
}
${'```'}
**Response:** 201 Created
${'```'}json
{
"id": "usr_9876543210",
"email": "newuser@example.com",
"name": "Jane Smith",
"role": "user",
"created_at": "2024-01-21T09:15:00Z"
}
${'```'}
### Error Responses
The API returns errors in a consistent format:
${'```'}json
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": [
{
"field": "email",
"message": "Email format is invalid"
}
]
}
}
${'```'}
### Rate Limiting
| Tier | Requests/Hour | Burst |
|------|--------------|-------|
| **Free** | 1,000 | 100 |
| **Pro** | 10,000 | 500 |
| **Enterprise** | Unlimited | - |
**Headers:**
- X-RateLimit-Limit
- X-RateLimit-Remaining
- X-RateLimit-Reset
### Webhooks
Configure webhooks to receive real-time events:
${'```'}javascript
// Webhook payload
{
"event": "user.created",
"timestamp": "2024-01-21T09:15:00Z",
"data": {
"id": "usr_9876543210",
"email": "newuser@example.com"
},
"signature": "sha256=abcd1234..."
}
${'```'}
### SDK Examples
**JavaScript/TypeScript:**
${'```'}typescript
import { ApiClient } from '@example/api-sdk';
const client = new ApiClient({
apiKey: process.env.API_KEY
});
const users = await client.users.list({
page: 1,
limit: 20
});
${'```'}
**Python:**
${'```'}python
from example_api import Client
client = Client(api_key=os.environ['API_KEY'])
users = client.users.list(page=1, limit=20)
${'```'}
---
📚 [Full API Reference](https://api.example.com/docs) | 💬 [Support](https://support.example.com)
`;
|