Menus API
v1.0 • REST • JSON
Full CRUD management for menu item accounts. Create, retrieve, update, and delete menu item records with built-in pagination and role-based access control support.
Quick Reference
/api/menus
200 OK
Get All Menus
Retrieves a paginated list of all menus in the system. Use the page
and limit query parameters to navigate large result sets.
The response envelope includes total count and page metadata.
| Parameter | Type | Default | Description |
|---|---|---|---|
page |
integer | 1 |
Page number, 1-based index |
limit |
integer | 10 |
Number of records per page |
/api/menus/{id}
200 OK
Get Single Menu Item
Fetch the full profile for a specific menu item using their numeric ID. Returns all menu item fields including assigned role names and account metadata.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | Unique menu item identifier |
/api/menus/{id}
404 Not Found
Menu Item Not Found
Returned when the requested menu item ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing menu item resources.
/api/menus
201 Created
Create Menu Item
Registers a new menu item with the provided details. On success, returns the newly created menu item object including the auto-generated ID, timestamp, and resolved role names.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
description |
string | Optional | Description |
restaurantName |
string | Required | Restaurant name |
category |
string | Required | Category |
price |
decimal | Required | Price |
isVegetarian |
boolean | Required | Is vegetarian |
isAvailable |
boolean | Required | Is available |
calories |
integer | Required | Calories |
/api/menus/{id}
200 OK
Update Menu Item
Fully replaces an existing menu item's data with the values in the request body. A successful update returns 200 OK with response body.
| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Required | Name |
description |
string | Optional | Description |
restaurantName |
string | Required | Restaurant name |
category |
string | Required | Category |
price |
decimal | Required | Price |
isVegetarian |
boolean | Required | Is vegetarian |
isAvailable |
boolean | Required | Is available |
calories |
integer | Required | Calories |
/api/menus/{id}
204 No Content
Delete Menu Item
Permanently removes a menu item from the system by their ID. This action is irreversible once deleted, the menu item record and all associated data cannot be recovered through the API.
| Parameter | Type | Required | Description |
|---|---|---|---|
id |
integer | Required | ID of the menu item to delete |