Restaurants API

v1.0 • REST • JSON

Full CRUD management for restaurant accounts. Create, retrieve, update, and delete restaurant records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/restaurants

Quick Reference

GET
/api/restaurants List all restaurants (paginated)
200 GET
/api/restaurants/{id} Get one restaurant by ID
200 POST
/api/restaurants Create a new restaurant
201 PUT
/api/restaurants/{id} Replace restaurant data
204 DEL
/api/restaurants/{id} Remove a restaurant
204 GET
/api/restaurants/{id} Restaurant not found example
404
GET /api/restaurants 200 OK

Get All Restaurants

Retrieves a paginated list of all restaurants in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/restaurants/{id} 200 OK

Get Single Restaurant

Fetch the full profile for a specific restaurant using their numeric ID. Returns all restaurant fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique restaurant identifier
Response: 200 OK
GET /api/restaurants/{id} 404 Not Found

Restaurant Not Found

Returned when the requested restaurant ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing restaurant resources.

Response: 404 Not Found
POST /api/restaurants 201 Created

Create Restaurant

Registers a new restaurant with the provided details. On success, returns the newly created restaurant object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
cuisine string Required Cuisine
city string Required City
country string Required Country
priceRange string Required Price range
rating decimal Required Rating
isOpen boolean Required Is open
Body
Response: 201 Created
PUT /api/restaurants/{id} 200 OK

Update Restaurant

Fully replaces an existing restaurant's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
name string Required Name
description string Optional Description
cuisine string Required Cuisine
city string Required City
country string Required Country
priceRange string Required Price range
rating decimal Required Rating
isOpen boolean Required Is open
Body
Response: 200 OK
DELETE /api/restaurants/{id} 204 No Content

Delete Restaurant

Permanently removes a restaurant from the system by their ID. This action is irreversible once deleted, the restaurant record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the restaurant to delete
Response: 204 No Content