Public
Documentation Settings

Travel API Documentation

Welcome to the API documentation for our Travel App a powerful platform designed to provide users with seamless travel recommendations and destination management, much like the popular service TripAdvisor. This API enables developers to integrate our travel recommendation features into their applications.

API Implementation Details

  • Database : We utilize MongoDB as the underlying database for storing travel destination information.
  • ODM : Mongoose is employed as the Object Data Modeling library to facilitate interaction with the MongoDB database.
  • Autentication : To ensure data security and user-specific interactions, make sure to implement authentication and authorization mechanisms in your application.

API ENDPOINTS

These API endpoints provide a comprehensive set of features to manage travel destinations, retrieve relevant information, and engage with user ratings and reviews on the platform.

  • Create a new travel destination : Allows you to add a new travel destination to the platform with details such as name, location, description, and rating.
  • Retrieve a travel destination by name : Fetches the details of a specific travel destination based on its name.
  • Retrieve list of all travel destination : Returns a list of all travel destinations available on the platform.
  • Retrieve travel destinations by location like city/country : Allows you to retrieve a list of travel destinations based on their location, which can be a city or country.
  • Retrieve travel destinations by rating : Retrieves travel destinations based on their ratings, categorized as either top-rated or low-rated.
  • Update a travel destination by ID : Enables you to update the details of a specific travel destination using its unique identifier (ID).
  • Delete a Travel destination by ID : Deletes a travel destination from the platform based on its unique identifier (ID).
  • Filter destinations by minimum rating : Filters and retrieves travel destinations with ratings equal to or higher than a specified minimum rating.
  • Add users review : Allows users to submit ratings and reviews for a specific travel destination using its ID.
  • Retrieve all reviews for a travel destination : Retrieves first three reviews associated with a particular travel destination using its ID.

API BASE URL

It is important to make all API requests to the base URL provided below. Please ensure that you use this URL for all your API requests

Plain Text
https://travel-api-sand.vercel.app/
Loading