Mock Food Ordering API
  1. General
Mock Food Ordering API
  • General
    • API Information
      GET
    • Health Check
      GET
  • Orders
    • List Orders
      GET
    • Create Order
      POST
    • Get Order by ID
      GET
    • Update Order
      PATCH
    • Delete Order
      DELETE
    • Cancel Order (Convenience Endpoint)
      PATCH
  • Schemas
    • Schemas
      • OrderStatus
      • OrderItem
      • Receipt
      • Order
      • CreateOrderRequest
      • UpdateOrderRequest
      • Pagination
      • OrderListData
      • ApiResponse
      • OrderResponse
      • OrderListResponse
      • DeleteResponse
      • HealthResponse
      • ApiInfoResponse
      • ErrorResponse
    • Response
      • BadRequest
      • NotFound
      • ValidationError
      • InternalServerError
  1. General

API Information

GET
/
Get basic information about the API and available endpoints

Request

None

Responses

🟢200OK
application/json
API information retrieved successfully
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/'
Response Response Example
{
    "success": true,
    "data": {
        "name": "Mock Food Ordering API",
        "version": "1.0.0",
        "description": "A mock REST API for food ordering system designed for QA testing",
        "endpoints": {
            "GET /orders": "List all orders with optional filtering",
            "POST /orders": "Create a new food order",
            "GET /orders/:id": "Get specific order details",
            "PATCH /orders/:id": "Update order status or cancel",
            "DELETE /orders/:id": "Delete/cancel order completely",
            "PATCH /orders/:id/cancel": "Cancel order (convenience endpoint)",
            "GET /health": "API health check"
        }
    }
}
Modified at 2025-09-17 13:22:25
Next
Health Check
Built with