API Reference

Overview

This page demonstrates how to document APIs using tables and structured content.

Retrieve user information by ID.

Endpoint: GET /api/users/:id

Name	Type	Required	Description
id	string	Yes	The unique user identifier

{
  "id": "123",
  "name": "John Doe",
  "email": "john@example.com",
  "createdAt": "2024-01-01T00:00:00Z"
}

Create a new user account.

Endpoint: POST /api/users

Field	Type	Required	Description
name	string	Yes	User's full name
email	string	Yes	User's email address
password	string	Yes	User's password (min 8 chars)

All API requests require authentication using a Bearer token:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://api.example.com/users/123