Loading…
Generate API documentation in Markdown, OpenAPI, or HTML format. Review the result before reusing it in another workflow.
# My API
**Version:** 1.0.0
**Base URL:** `https://api.example.com`
REST API documentation
---
## Endpoints
### GET /api/users
**List all users**
Retrieve a paginated list of all users in the system
#### Parameters
| Name | Type | Required | Description |
|------|------|----------|-------------|
| page | integer | No | Page number |
| limit | integer | No | Items per page |
#### Response
```json
{
"data": [
{ "id": 1, "name": "John Doe", "email": "john@example.com" }
],
"pagination": { "page": 1, "limit": 10, "total": 100 }
}
```
---
### POST /api/users
**Create a new user**
Create a new user account with the provided information
#### Request Body
```json
{
"name": "John Doe",
"email": "john@example.com",
"password": "securePassword123"
}
```
#### Response
```json
{
"id": 1,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2024-01-15T10:30:00Z"
}
```
---