This is your API Reference page. Replace this content with your actual API documentation.
API Method Badges
Color-coded HTTP method badges. Add via Ghost's HTML card:
<span class="docs-api-method api-get">GET</span> <code>/endpoint</code>Available methods:
GET /your/endpoint — Green for read operations
POST /your/endpoint — Blue for create operations
PUT /your/endpoint — Orange for update operations
DELETE /your/endpoint — Red for delete operations
How to Document an Endpoint
Example
GET /v2/users
Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Max results (default: 25) |
offset | integer | No | Results to skip |
Response:
{
"success": true,
"data": [{ "id": "usr_abc123", "email": "user@example.com" }],
"meta": { "total": 42 }
}How to Edit
- Replace example endpoints with your real API
- Add method badges via HTML cards
- For large APIs, create one post per resource group, all tagged "API Reference"