Restaurant API Documentation
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.
API Implementations details
- Database : Used MongoDB for storing restaurants information
- ODM : mongoose user for interacting with the mongodb database
API Endpoints
These API provides comprehensive set of features to manage restaurants data , menus , user rating reviews on the platform
Restaurant Management:
Creating Restaurant : Allow to add new restaurant information with essentia details such as name, cuisine, address, menus and more.
Read a Restaurant : fetch restaurant details based on its name.
Reading all Restaurants : fetch all restaurants information stored in the database.
Reading Restaurants by cuisine : allow to fetch restaurants with filter based on cuisine type
Updating a Restaurant : Provides the capability to update restaurant information, including ratings, address, and other relevant details, using its unique identifier (ID)
Deleting a Restaurant : Allows for the removal of a restaurant from our platform, ensuring data accuracy and relevance.
search for Restaurants by location : Facilitates location-based searches, enabling users to find restaurants in specific cities or addresses effortlessly.
Filtering Restaurants by Rating: Allows users to filter restaurants by a minimum rating
Menu Management :
Add a Dish to menus of Restaurant: Add a new dish to the array of menus in Restaurant object
Remove a Dish from menus of Restaurant : remove a dish from the array of menus in Restaurant object