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

Health Check

GET
/health
Check if the API is running and healthy

Request

None

Responses

🟢200OK
application/json
API is healthy
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/health'
Response Response Example
{
    "success": true,
    "data": {
        "status": "healthy",
        "timestamp": "2024-01-15T10:30:00.000Z",
        "version": "1.0.0",
        "environment": "development"
    }
}
Modified at 2025-09-17 13:22:25
Previous
API Information
Next
List Orders
Built with