Tour-App-API

Tour-App-API is a RESTful API designed for mobile tour applications. It provides endpoints for various features such as user authentication, creating and managing tours, creating and managing tour stops, and retrieving tour information.

Getting Started

To use Tour-App-API, you will need to have a basic understanding of RESTful APIs and HTTP requests. You will also need to have a programming language that can make HTTP requests (e.g. JavaScript, Python, or PHP) and an API testing tool such as Postman.

Installing

To install Tour-App-API, simply clone the repository from GitHub.

git clone https://github.com/yourUsername/tour-app-api.git

Next, navigate to the project directory and install the required dependencies.

cd tour-app-api
npm install

Finally, start the server.

npm start

API Endpoints

Tour-App-API has the following endpoints:

User Endpoints

• POST /api/v1/users/signup

  Sign up a new user to the platform using a JSON object in the request body with the following properties:

  • email (required)
  • password (required)
  • name (optional)

• POST /api/v1/users/login

  Authenticate a user on the platform using a JSON object in the request body with the following properties:

  • email (required)
  • password (required)

Tour Endpoints

• POST /api/v1/tours

  Create a new tour by sending a JSON object in the request body with the following properties:

  • name (required)
  • description (required)
  • duration (required)
  • maxGroupSize (required)
  • difficulty (required)
  • price (required)

• GET /api/v1/tours

  Get all tours.

• GET /api/v1/tours/:id

  Get a single tour by ID.

• PATCH /api/v1/tours/:id

  Update a tour by ID using a JSON object in the request body with the following properties:

  • name (optional)
  • description (optional)
  • duration (optional)
  • maxGroupSize (optional)
  • difficulty (optional)
  • price (optional)

• DELETE /api/v1/tours/:id

  Delete a tour by ID.

Tour Stop Endpoints

• POST /api/v1/tours/:tourId/stops

  Create a new tour stop for a tour by ID using a JSON object in the request body with the following properties:

  • name (required)
  • description (optional)
  • location (required)
  • coordinates (required)

• GET /api/v1/tours/:tourId/stops

  Get all tour stops for a tour by ID.

• GET /api/v1/tours/:tourId/stops/:stopId

  Get a single tour stop for a tour by ID and stop ID.

• PATCH /api/v1/tours/:tourId/stops/:stopId

  Update a tour stop for a tour by ID and stop ID using a JSON object in the request body with the following properties:

  • name (optional)
  • description (optional)
  • location (optional)
  • coordinates (optional)

• DELETE /api/v1/tours/:tourId/stops/:stopId

  Delete a tour stop for a tour by ID and stop ID.

Conclusion

Tour-App-API provides an easy-to-use and scalable platform for mobile tour applications. The API endpoints are well-defined and provide users with the necessary functionality to create and manage tours and tour stops.