Template
API Documentation Generator
Generate professional API reference documentation in Markdown.
API Information
Endpoints
Preview
markdown# My API API Documentation
**Base URL**: `https://api.example.com/v1`
**Version**: v1
**Content-Type**: `application/json`
## Overview
A comprehensive RESTful API for managing resources
## Authentication
Include your API key in the request header:
```http
Authorization: Bearer YOUR_API_KEY
```
## Rate Limiting
- Standard: 1,000 req/hour
- Professional: 10,000 req/hour
- Enterprise: Unlimited
## Endpoints
### GET /users
Retrieve all users
```bash
curl -X GET "https://api.example.com/v1/users" \
-H "Authorization: Bearer YOUR_API_KEY"
```
### POST /users
Create a new user
```bash
curl -X POST "https://api.example.com/v1/users" \
-H "Authorization: Bearer YOUR_API_KEY"
```
### DELETE /users/:id
Delete a user by ID
```bash
curl -X DELETE "https://api.example.com/v1/users/:id" \
-H "Authorization: Bearer YOUR_API_KEY"
```
## Error Format
```json
{
"error": "ERROR_CODE",
"message": "Human-readable description",
"timestamp": "2025-01-01T00:00:00Z"
}
```
## HTTP Status Codes
| Code | Meaning |
|------|---------|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Rate Limit Exceeded |
| 500 | Internal Server Error |
---
*Last updated: July 2026*