API Documentation

This documentation provides details about available endpoints and how to interact with them.

Base URL

All API endpoints are relative to:

https://[your-domain]/api
API Testing Tool
Response
Response will appear here

GET Endpoints

GET /api/items

Returns a list of all items.

Query Parameters
Parameter Type Description
name string Filter items by name (optional)
Example Response
{
  "items": [
    {
      "id": 1,
      "name": "Sample Item",
      "description": "This is a sample item in our API",
      "created_at": "2023-01-01T12:00:00"
    }
  ],
  "count": 1
}

GET /api/items/:id

Returns a specific item by ID.

Path Parameters
Parameter Type Description
id integer ID of the item to retrieve
Example Response
{
  "item": {
    "id": 1,
    "name": "Sample Item",
    "description": "This is a sample item in our API",
    "created_at": "2023-01-01T12:00:00"
  }
}
Error Response (404 Not Found)
{
  "error": "Item with ID 999 not found"
}

POST Endpoints

POST /api/items

Creates a new item.

Request Body
Field Type Required Description
name string Yes Name of the item
description string No Description of the item
Example Request
{
  "name": "New Item",
  "description": "This is a new item created via the API"
}
Example Response (201 Created)
{
  "message": "Item created successfully",
  "item": {
    "id": 2,
    "name": "New Item",
    "description": "This is a new item created via the API",
    "created_at": "2023-08-15T14:30:45.123456"
  }
}
Error Response (400 Bad Request)
{
  "error": "Name is required"
}

PUT and DELETE Endpoints

PUT /api/items/:id

Updates an existing item.

Path Parameters
Parameter Type Description
id integer ID of the item to update
Request Body
Field Type Required Description
name string No New name for the item
description string No New description for the item
Example Request
{
  "name": "Updated Item Name",
  "description": "This item has been updated"
}
Example Response
{
  "message": "Item updated successfully",
  "item": {
    "id": 1,
    "name": "Updated Item Name",
    "description": "This item has been updated",
    "created_at": "2023-01-01T12:00:00"
  }
}

DELETE /api/items/:id

Deletes an item.

Path Parameters
Parameter Type Description
id integer ID of the item to delete
Example Response
{
  "message": "Item with ID 1 deleted successfully"
}
Error Response (404 Not Found)
{
  "error": "Item with ID 999 not found"
}