API Examples

This page demonstrates how to document APIs.

GET /users

Returns a list of users.

Parameters:

• page (optional, number): The page number.
• limit (optional, number): Number of items per page.

Example Request:

curl -X GET "https://api.example.com/users?page=1&limit=10"

Example Response (200 OK):

[
  {
    "id": 1,
    "name": "Alice",
    "email": "alice@example.com"
  },
  {
    "id": 2,
    "name": "Bob",
    "email": "bob@example.com"
  }
]

POST /users

Creates a new user.

Request Body:

{
  "name": "Charlie",
  "email": "charlie@example.com"
}

Example Request:

curl -X POST "https://api.example.com/users" \
     -H "Content-Type: application/json" \
     -d '{"name": "Charlie", "email": "charlie@example.com"}'

Example Response (201 Created):

{
  "id": 3,
  "name": "Charlie",
  "email": "charlie@example.com"
}