1a567be793
- Copy code/image/config files across all modules - Translate brand-voice and code-review templates - Translate CONTRIBUTING, CODE_OF_CONDUCT, SECURITY, STYLE_GUIDE - Copy CHANGELOG as-is (technical log) Ref: luongnv89/claude-howto#63
102 lines
1.7 KiB
Markdown
102 lines
1.7 KiB
Markdown
# [METHOD] /api/v1/[endpoint]
|
|
|
|
## Description
|
|
Brief explanation of what this endpoint does.
|
|
|
|
## Authentication
|
|
Required authentication method (e.g., Bearer token).
|
|
|
|
## Parameters
|
|
|
|
### Path Parameters
|
|
| Name | Type | Required | Description |
|
|
|------|------|----------|-------------|
|
|
| id | string | Yes | Resource ID |
|
|
|
|
### Query Parameters
|
|
| Name | Type | Required | Description |
|
|
|------|------|----------|-------------|
|
|
| page | integer | No | Page number (default: 1) |
|
|
| limit | integer | No | Items per page (default: 20) |
|
|
|
|
### Request Body
|
|
```json
|
|
{
|
|
"field": "value"
|
|
}
|
|
```
|
|
|
|
## Responses
|
|
|
|
### 200 OK
|
|
```json
|
|
{
|
|
"success": true,
|
|
"data": {
|
|
"id": "123",
|
|
"name": "Example"
|
|
}
|
|
}
|
|
```
|
|
|
|
### 400 Bad Request
|
|
```json
|
|
{
|
|
"success": false,
|
|
"error": {
|
|
"code": "VALIDATION_ERROR",
|
|
"message": "Invalid input"
|
|
}
|
|
}
|
|
```
|
|
|
|
### 404 Not Found
|
|
```json
|
|
{
|
|
"success": false,
|
|
"error": {
|
|
"code": "NOT_FOUND",
|
|
"message": "Resource not found"
|
|
}
|
|
}
|
|
```
|
|
|
|
## Examples
|
|
|
|
### cURL
|
|
```bash
|
|
curl -X GET "https://api.example.com/api/v1/endpoint" \
|
|
-H "Authorization: Bearer YOUR_TOKEN" \
|
|
-H "Content-Type: application/json"
|
|
```
|
|
|
|
### JavaScript
|
|
```javascript
|
|
const response = await fetch('/api/v1/endpoint', {
|
|
headers: {
|
|
'Authorization': 'Bearer token',
|
|
'Content-Type': 'application/json'
|
|
}
|
|
});
|
|
const data = await response.json();
|
|
```
|
|
|
|
### Python
|
|
```python
|
|
import requests
|
|
|
|
response = requests.get(
|
|
'https://api.example.com/api/v1/endpoint',
|
|
headers={'Authorization': 'Bearer token'}
|
|
)
|
|
data = response.json()
|
|
```
|
|
|
|
## Rate Limits
|
|
- 1000 requests per hour for authenticated users
|
|
- 100 requests per hour for public endpoints
|
|
|
|
## Related Endpoints
|
|
- [GET /api/v1/related](#)
|
|
- [POST /api/v1/related](#)
|