📝Markdown & HTML

Simple API Documentation

Clean markdown structure for documenting endpoints.

Explanation

Standardizes how you present URL, methods, params, and responses.

Examples

Endpoint Doc

Output

### GET /users
**Parameters**
- `id`: number

Code Examples

API Doc

### GET /api/v1/resource

Returns a list of resources.

**Authentication Required:** Yes

**Query Parameters:**
| Name | Type | Description |
|------|------|-------------|
| limit | int | Number of results |

**Response (200 OK):**
```json
{ "data": [] }
```

Try it Now

Open in Markdown Preview

💡 Tips

Use tables for parameters and error codes
Always include an example request and response
Clearly state if authentication is required

⚠️ Common Pitfalls

Outdated documentation is worse than no documentation