welcome to the Restaurant API similar to Zomato . This document provides comprehensive information on the RESTful API that power our restaurant platform, allowing developers to create, manage and access restaurant data, manus, user reviews and more.
\nThese API provides comprehensive set of features to manage restaurants data , menus , user rating reviews on the platform
\nCreating Restaurant : Allow to add new restaurant information with essentia details such as name, cuisine, address, menus and more.
\nRead a Restaurant : fetch restaurant details based on its name.
\nReading all Restaurants : fetch all restaurants information stored in the database.
\nReading Restaurants by cuisine : allow to fetch restaurants with filter based on cuisine type
\nUpdating a Restaurant : Provides the capability to update restaurant information, including ratings, address, and other relevant details, using its unique identifier (ID)
\nDeleting a Restaurant : Allows for the removal of a restaurant from our platform, ensuring data accuracy and relevance.
\nsearch for Restaurants by location : Facilitates location-based searches, enabling users to find restaurants in specific cities or addresses effortlessly.
\nFiltering Restaurants by Rating: Allows users to filter restaurants by a minimum rating
\nAdd a Dish to menus of Restaurant: Add a new dish to the array of menus in Restaurant object
\nRemove a Dish from menus of Restaurant : remove a dish from the array of menus in Restaurant object
\nhttps://restaurant-api-seven.vercel.app/\n\nGET /restaurantsDescription : This request retrieve all restaurants data from the database. The response contains array of object representing a restaurant with unique id , name , location , city, address, cuisine type, menus and more.
\n","urlObject":{"protocol":"https","path":["restaurants"],"host":["restaurant-api-seven","vercel","app"],"query":[],"variable":[]}},"response":[{"id":"6a015e6c-cf5f-45cb-a1c0-f9e96dcfdbaa","name":"New Request","originalRequest":{"method":"GET","header":[],"url":"https://restaurant-api-seven.vercel.app/restaurants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Age","value":"0"},{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Date","value":"Fri, 19 Jan 2024 05:21:21 GMT"},{"key":"Etag","value":"W/\"4a8-vSGq3yeyAQdiDLPZjIZYBieivTk\""},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Dns-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"bom1::iad1::w47tp-1705641677454-0c2301daf21d"},{"key":"X-Xss-Protection","value":"0"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"restaurants\": [\n {\n \"_id\": \"659743c3079510eb43d250d3\",\n \"name\": \"Delicious Bites\",\n \"cuisine\": \"Italian\",\n \"address\": \"123 Main Street\",\n \"city\": \"Foodville\",\n \"rating\": 4.5,\n \"menu\": [\n {\n \"name\": \"Spaghetti Bolognese\",\n \"price\": 15.99,\n \"description\": \"Spaghetti with meat sauce and Parmesan cheese\",\n \"isVeg\": \"true\",\n \"_id\": \"659743c3079510eb43d250d5\"\n },\n {\n \"name\": \"Tiramisu\",\n \"price\": 7.99,\n \"description\": \"Classic Italian dessert with coffee and mascarpone\",\n \"isVeg\": \"false\",\n \"_id\": \"659743c3079510eb43d250d6\"\n }\n ],\n \"__v\": 6,\n \"averageRating\": 4.666666666666667,\n \"reviews\": [\n {\n \"rating\": 4.5,\n \"text\": \"Great food and excellent service!\",\n \"_id\": \"65a57c5206923e411ec59bf3\"\n },\n {\n \"userId\": \"65a57950ba675b09b03706ea\",\n \"rating\": 4.5,\n \"text\": \"Great food and excellent service!\",\n \"_id\": \"65a57d7ddb8c731791d13570\"\n },\n {\n \"userId\": \"65a57950ba675b09b03706ea\",\n \"rating\": 5,\n \"text\": \"average restaurant\",\n \"_id\": \"65a57da6db8c731791d13577\"\n }\n ]\n },\n {\n \"_id\": \"65a2dcabe08e197a8b55dbc4\",\n \"name\": \"New Restaurant\",\n \"cuisine\": \"Italian\",\n \"address\": \"123 Main St\",\n \"city\": \"New York\",\n \"rating\": 4.5,\n \"menu\": [\n {\n \"name\": \"Pizza Margherita\",\n \"price\": 12.99,\n \"_id\": \"65a2dcabe08e197a8b55dbc5\"\n },\n {\n \"name\": \"Pasta Carbonara\",\n \"price\": 15.99,\n \"_id\": \"65a2dcabe08e197a8b55dbc6\"\n }\n ],\n \"averageRating\": 0,\n \"__v\": 0,\n \"reviews\": []\n }\n ]\n }\n}"}],"_postman_id":"095fef73-83be-4e54-b877-d0ecc3b283cf"},{"name":"Creating a Restaurant","id":"3a914695-b6d0-45ac-88d0-717241d6dffd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n{\n \"name\": \"Spice Delight\",\n \"cuisine\": \"Indian\",\n \"address\": \"789 Oak Lane\",\n \"city\": \"Chicago\",\n \"rating\": 4.0,\n \"menu\": [\n {\n \"name\": \"Pad Thai\",\n \"price\": 10.99,\n \"description\": \"Stir-fried noodles with shrimp\",\n \"isVeg\": false\n },\n {\n \"name\": \"Butter Chicken\",\n \"price\": 13.99,\n \"description\": \"Creamy tomato sauce with chicken\",\n \"isVeg\": false\n }\n ],\n \"averageRating\": 4.2\n}","options":{"raw":{"language":"json"}}},"url":"https://restaurant-api-seven.vercel.app/restaurants","description":"Endpoint : POST /restaurants
Description : Allows you to add new restaurants to our platform, complete with essential details such as name, cuisine type, address, and more.
\nEndpoint : GET /restaurants/:name
Description : This request fetch a restaurant on the basis of the restaurant name.
\nParameters : Name
\nEndpoint : GET /restaurants/cuisine/:cuisineType
Description : This request fetch all restaurant based on the cuisine type
\nParameters : Cuisine type
\nEndpoint : POST /restaurants/:restaurantId
Description : Provides the capability to update restaurant information, including ratings, address, and other relevant details, using its unique identifier (ID).
\n","urlObject":{"protocol":"https","path":["restaurants","65aa0c0b6dcb659f989184e9"],"host":["restaurant-api-seven","vercel","app"],"query":[],"variable":[]}},"response":[{"id":"cffad91a-056f-4791-bec3-cc945cb013d1","name":"New Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\":\"Updated Name\",\n \"city\":\"Updated city\"\n}","options":{"raw":{"language":"json"}}},"url":"https://restaurant-api-seven.vercel.app/restaurants/65aa0c0b6dcb659f989184e9"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"475"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Date","value":"Fri, 19 Jan 2024 16:27:13 GMT"},{"key":"Etag","value":"W/\"1db-tTOarRzq4VOsAzDJanrNw5XcBmY\""},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Dns-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"bom1::iad1::htlkh-1705681629016-9ef0c1b1cbf0"},{"key":"X-Xss-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"restaurant\": {\n \"_id\": \"65aa0c0b6dcb659f989184e9\",\n \"name\": \"Updated Name\",\n \"cuisine\": \"Indian\",\n \"address\": \"789 Oak Lane\",\n \"city\": \"Updated city\",\n \"rating\": 4,\n \"menu\": [\n {\n \"name\": \"Pad Thai\",\n \"price\": 10.99,\n \"description\": \"Stir-fried noodles with shrimp\",\n \"isVeg\": \"false\",\n \"_id\": \"65aa0c0b6dcb659f989184ea\"\n },\n {\n \"name\": \"Butter Chicken\",\n \"price\": 13.99,\n \"description\": \"Creamy tomato sauce with chicken\",\n \"isVeg\": \"false\",\n \"_id\": \"65aa0c0b6dcb659f989184eb\"\n }\n ],\n \"averageRating\": 4.2,\n \"reviews\": [],\n \"__v\": 0\n }\n }\n}"}],"_postman_id":"8bf28c4c-abee-420b-96d7-84a8b7a9826e"},{"name":"search restaurant by location","id":"6d95e54e-9eb7-4579-92ec-15bab443a031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://restaurant-api-seven.vercel.app/restaurants/search?location=Foodville","description":"Endpoint : GET /restaurants/search
Description : Facilitates location-based searches, enabling users to find restaurants in specific cities or addresses effortlessly.
\n","urlObject":{"protocol":"https","path":["restaurants","search"],"host":["restaurant-api-seven","vercel","app"],"query":[{"key":"location","value":"Foodville"}],"variable":[]}},"response":[{"id":"81635d15-1d99-4952-b127-38fa0d248916","name":"search restaurant by location","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://restaurant-api-seven.vercel.app/restaurants/search?location=Foodville","protocol":"https","host":["restaurant-api-seven","vercel","app"],"path":["restaurants","search"],"query":[{"key":"location","value":"Foodville"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Age","value":"0"},{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"861"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Date","value":"Sat, 20 Jan 2024 05:38:45 GMT"},{"key":"Etag","value":"W/\"35d-mRjkO5H+Lvs4/8ekwi0MLA96el0\""},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Dns-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"bom1::iad1::5xcn8-1705729120394-a5f66a703486"},{"key":"X-Xss-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"restaurants\": [\n {\n \"_id\": \"659743c3079510eb43d250d3\",\n \"name\": \"Delicious Bites\",\n \"cuisine\": \"Italian\",\n \"address\": \"123 Main Street\",\n \"city\": \"Foodville\",\n \"rating\": 4.5,\n \"menu\": [\n {\n \"name\": \"Spaghetti Bolognese\",\n \"price\": 15.99,\n \"description\": \"Spaghetti with meat sauce and Parmesan cheese\",\n \"isVeg\": \"true\",\n \"_id\": \"659743c3079510eb43d250d5\"\n },\n {\n \"name\": \"Tiramisu\",\n \"price\": 7.99,\n \"description\": \"Classic Italian dessert with coffee and mascarpone\",\n \"isVeg\": \"false\",\n \"_id\": \"659743c3079510eb43d250d6\"\n }\n ],\n \"__v\": 6,\n \"averageRating\": 4.666666666666667,\n \"reviews\": [\n {\n \"rating\": 4.5,\n \"text\": \"Great food and excellent service!\",\n \"_id\": \"65a57c5206923e411ec59bf3\"\n },\n {\n \"userId\": \"65a57950ba675b09b03706ea\",\n \"rating\": 4.5,\n \"text\": \"Great food and excellent service!\",\n \"_id\": \"65a57d7ddb8c731791d13570\"\n },\n {\n \"userId\": \"65a57950ba675b09b03706ea\",\n \"rating\": 5,\n \"text\": \"average restaurant\",\n \"_id\": \"65a57da6db8c731791d13577\"\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"6d95e54e-9eb7-4579-92ec-15bab443a031"},{"name":"Delete a Restaurant","id":"86de5677-1e73-4ca4-aa26-6b14a71bb87a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://restaurant-api-seven.vercel.app/restaurants/65ab63b687c8aed50329ac0c","description":"Endpoint: DELETE /restaurants/:restaurantId
Description: Allows for the removal of a restaurant from our platform, ensuring data accuracy and relevance.
\nEndpoint: GET /restaurants/rating/:minRating
Description: Allows users to filter restaurants by a minimum rating.
\nRestaurant Management provides a suite of essential features for efficiently handling restaurant-related operations. Key functionalities include restaurant creation, retrieval by name, listing all restaurants, filtering by cuisine type, updating restaurant information by ID, deleting restaurants by ID, searching by location, and filtering by rating, enabling a comprehensive restaurant management experience.
\n","_postman_id":"e5de777e-6f00-4d32-95ec-48942f72de9a"},{"name":"Menu Management","item":[{"name":"Adding a dish to menu of restaurant","id":"10fa7e76-f8d5-405c-8740-332ee18b1678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"name\": \"Butter Chicken\",\n \"price\": 13.99,\n \"description\": \"Creamy tomato sauce with chicken\",\n \"isVeg\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://restaurant-api-seven.vercel.app/restaurants/65a2dcabe08e197a8b55dbc4/menu","description":"Endpoint : POST /restaurants/:restaurantId/reviews
Description : Lets restaurants update their menus by adding new dishes, enhancing menu offerings.
\n","urlObject":{"protocol":"https","path":["restaurants","65a2dcabe08e197a8b55dbc4","menu"],"host":["restaurant-api-seven","vercel","app"],"query":[],"variable":[]}},"response":[{"id":"13b7f701-ff61-44f9-8623-92bef2e1a94a","name":"New Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":" {\n \"name\": \"Butter Chicken\",\n \"price\": 13.99,\n \"description\": \"Creamy tomato sauce with chicken\",\n \"isVeg\": false\n }","options":{"raw":{"language":"json"}}},"url":"https://restaurant-api-seven.vercel.app/restaurants/65a2dcabe08e197a8b55dbc4/menu"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Cache-Control","value":"public, max-age=0, must-revalidate"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Length","value":"509"},{"key":"Content-Security-Policy","value":"default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"},{"key":"Cross-Origin-Resource-Policy","value":"same-origin"},{"key":"Date","value":"Sat, 20 Jan 2024 06:19:06 GMT"},{"key":"Etag","value":"W/\"1fd-/kDd7Zl99ZDMu7NjXSLGWRaELxc\""},{"key":"Origin-Agent-Cluster","value":"?1"},{"key":"Referrer-Policy","value":"no-referrer"},{"key":"Server","value":"Vercel"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Dns-Prefetch-Control","value":"off"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"X-Vercel-Cache","value":"MISS"},{"key":"X-Vercel-Id","value":"bom1::iad1::5w48d-1705731546336-ce2a409e72da"},{"key":"X-Xss-Protection","value":"0"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"menu is added\",\n \"restaurant\": {\n \"_id\": \"65a2dcabe08e197a8b55dbc4\",\n \"name\": \"New Restaurant\",\n \"cuisine\": \"Italian\",\n \"address\": \"123 Main St\",\n \"city\": \"New York\",\n \"rating\": 4.5,\n \"menu\": [\n {\n \"name\": \"Pizza Margherita\",\n \"price\": 12.99,\n \"_id\": \"65a2dcabe08e197a8b55dbc5\"\n },\n {\n \"name\": \"Pasta Carbonara\",\n \"price\": 15.99,\n \"_id\": \"65a2dcabe08e197a8b55dbc6\"\n },\n {\n \"name\": \"Butter Chicken\",\n \"price\": 13.99,\n \"description\": \"Creamy tomato sauce with chicken\",\n \"isVeg\": \"false\",\n \"_id\": \"65ab65daa0eee69ff84e4a8b\"\n }\n ],\n \"averageRating\": 0,\n \"__v\": 1,\n \"reviews\": []\n }\n}"}],"_postman_id":"10fa7e76-f8d5-405c-8740-332ee18b1678"},{"name":"Delete Dish from menu of restaurant","id":"5fb51d52-58c3-4c78-b2f5-30d0e92aaabc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://restaurant-api-seven.vercel.app/restaurants/65a2dcabe08e197a8b55dbc4/menu/65a2dcabe08e197a8b55dbc6","description":"DELETE /restaurants/restaurantId/menu/dishIdMenu Management streamlines the process of managing restaurant menus within your application. With two essential endpoints, it allows you to effortlessly add new dishes to a restaurant's menu and remove dishes that are no longer available. This API simplifies menu updates and ensures that users have access to the most up-to-date restaurant offerings.
\n","_postman_id":"2db3eac9-8181-4081-ae40-934c01c2ba21"},{"name":"User Reviews Management","item":[{"name":"Retrieving User Reviews for a Specific Restaurant","id":"d5b4b0f0-d7c2-460a-848d-ef3220ff824b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://restaurant-api-seven.vercel.app/restaurants/65ab7ff0185cf59a9f720d5a/reviews","description":"Endpoint : GET /restaurants/restaurantId/reviews
Description : Provides access to user reviews for a particular restaurant, helping users make informed dining choices.
\nEndpoint : POST /restaurants/:restaurantId/reviews
Description : Empowers users to share their dining experiences by adding ratings and reviews for specific restaurants.
\nUser Reviews Management facilitates seamless user interaction and feedback within your application. With these endpoints, users can easily add detailed reviews and ratings for restaurants, enhancing the dining experience for others. Additionally, the API allows for the retrieval of user reviews specific to a particular restaurant, offering valuable insights and recommendations for users seeking to make informed dining choices.
\n","_postman_id":"cdd2f4fb-b950-4417-9f14-b73133da115b"}]}