📘 API Documentation

📘 Introduction

Welcome to the API Documentation. Here you'll find all the information you need to interact with our RESTful API.

🔐 Authentication

All requests must include an API key:

Authorization: Bearer YOUR_API_KEY
        

📄 GET /users

Returns a list of users.

GET https://yourapi.com/users
        

Response:

[
  {
    "id": 1,
    "name": "Alice"
  },
  {
    "id": 2,
    "name": "Bob"
  }
]
        

📤 POST /users

Creates a new user.

POST https://yourapi.com/users
Content-Type: application/json

{
  "name": "Charlie"
}
        

Response:

{
  "id": 3,
  "name": "Charlie"
}
        

🚨 Error Codes

• 400 Bad Request: Missing or invalid parameters
• 401 Unauthorized: Invalid API key
• 404 Not Found: Resource does not exist
• 500 Server Error: Something went wrong