API Reference

This section contains the API documentation for your project.

Overview

Here you can document your APIs, including endpoints, parameters, and responses.

Authentication

Describe how to authenticate with your API:

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

Endpoints

GET /users

Retrieve a list of users.

Parameters:

• limit (number, optional): Maximum number of users to return
• offset (number, optional): Number of users to skip

Response:

{
  "users": [
    {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com"
    }
  ],
  "total": 100
}

POST /users

Create a new user.

Request Body:

{
  "name": "Jane Doe",
  "email": "jane@example.com"
}

Response:

{
  "id": 2,
  "name": "Jane Doe",
  "email": "jane@example.com",
  "created_at": "2023-01-01T00:00:00Z"
}