The Booking App is a backend system designed to manage hotel reservations with a secure, scalable, and user-friendly architecture. It provides endpoints for handling users, cities, hotels, images, bookings, and reviews, ensuring a complete ecosystem for a hotel booking platform.
\nThe goal of the Booking App is to simulate a real-world hotel reservation system, allowing users to:
\nRegister and log in securely.
\nExplore and filter hotels by city or name.
\nMake and manage reservations.
\nShare reviews and ratings.
\nAccess hotel images and details.
\nUser Management: Registration, login, profile updates, and secure authentication.
\nCity Management: CRUD operations for cities, with country codes for easy identification.
\nHotel Management: Search hotels by name or city, view details, and calculate average ratings from reviews.
\nImage Management: Associate multiple images with hotels for richer content.
\nBooking System: Create, update, and delete reservations linked to logged-in users.
\nReview System: Post and manage reviews with pagination and filtering by hotel.
\nThe backend is seeded with realistic data to support testing and scalability:
\n100 registered users
\n30 cities
\n150 hotels
\n300+ bookings
\n100+ reviews
\n300+ hotel images
\nPublic endpoints for browsing hotels, cities, and reviews.
\nPrivate endpoints secured with authentication for managing users, bookings, hotels, and images.
\nSmart queries and pagination for efficient data handling.
\nThe Users folder contains all endpoints related to user management and authentication in the Booking App backend. These routes allow you to register new users, manage existing accounts, and handle secure login with token-based authentication.
\nπ Key Features
\nPOST /users β Register a new user
POST /users/login β Authenticate and obtain a token
Private access (requires Bearer token):
\nGET /users β Retrieve all registered users
PUT /users/:id β Update user details by ID
DELETE /users/:id β Remove a user by ID
𧩠Model
\nEach user record includes:
\nid (primary key)
firstName
lastName
email
password (securely stored)
gender
π Security
\nLogin generates a JWT or token stored in {{authToken}}.
All private endpoints require the token in the Authorization header.
\nPasswords are never exposed in responses.
\nThe Cities folder contains all endpoints related to managing city records in the Booking App backend. These routes allow you to create, update, delete, and list cities, which serve as the foundation for associating hotels with their geographic location.
\nπ Key Features
\nGET /cities β Retrieve all available cities
Private access (requires Bearer token):
\nPOST /cities β Create a new city
PUT /cities/:id β Update an existing city by ID
DELETE /cities/:id β Remove a city by ID
𧩠Model
\nEach city record includes:
\nid (primary key)
name (e.g., Guadalajara, BogotΓ‘, New York)
country (full country name)
countryId (string code, e.g., MX, CO, US)
π Dataset
\nThe backend is seeded with 30 cities, ensuring diverse test data for hotel associations and queries.
\nπ Security
\nOnly authenticated users can create, update, or delete cities.
\nPublic endpoints allow anyone to browse the list of cities.
\nThe Hotels folder contains all endpoints related to hotel management in the Booking App backend. These routes allow you to browse, filter, create, update, and delete hotel records, as well as retrieve detailed information about each property.
\nπ Key Features
\nGET /hotels β Retrieve all hotels, with optional queries for name and cityId.
Example: /hotels?name=Four Seasons&cityId=1
Each hotel includes an average field showing the mean rating from its reviews.
\nGET /hotels/:id β Retrieve a single hotel by ID.
Private access (requires Bearer token):
\nPOST /hotels β Create a new hotel record.
PUT /hotels/:id β Update hotel details by ID.
DELETE /hotels/:id β Remove a hotel by ID.
𧩠Model
\nEach hotel record includes:
\nid (primary key)
name
description
price
address
lat (latitude)
lon (longitude)
cityId (reference to the city)
π Dataset
\nThe backend is seeded with 150 hotels, each linked to one of the 30 available cities. Hotels are enriched with images, reviews, and booking data to support realistic testing scenarios.
\nπ Security
\nPublic endpoints allow anyone to explore hotels and their details.
\nPrivate endpoints require authentication with a valid token.
\nThe Bookings folder contains all endpoints related to hotel reservations in the Booking App backend. These routes allow logged-in users to create, view, update, and delete their reservations, ensuring a secure and personalized booking experience.
\nπ Key Features
\nPrivate access (requires Bearer token):
\nGET /bookings β Retrieve all bookings of the logged-in user.
POST /bookings β Create a new booking. The userId is automatically inferred from the authenticated user.
PUT /bookings/:id β Update booking dates (checkIn and checkOut only). userId and hotelId cannot be modified.
DELETE /bookings/:id β Cancel a booking by ID.
𧩠Model
\nEach booking record includes:
\nid (primary key)
checkIn (date)
checkOut (date)
userId (linked to logged-in user)
hotelId (linked to hotel)
π Dataset
\nThe backend is seeded with 300+ bookings, providing realistic scenarios for testing reservation flows, date updates, and cancellations.
\nπ Security
\nAll booking endpoints are private and require authentication.
\nThe system ensures that users can only access and manage their own reservations.
\nThe Reviews folder contains all endpoints related to hotel reviews in the Booking App backend. These routes allow users to share feedback about their stays, manage their own reviews, and browse reviews from other guests with pagination and filtering options.
\nπ Key Features
\nGET /reviews β Retrieve all reviews.
Supports queries for hotelId to filter reviews by hotel.
Supports offset and perPage for pagination (e.g., /reviews?hotelId=1&offset=0&perPage=10).
Private access (requires Bearer token):
\nPOST /reviews β Create a new review. The userId is automatically inferred from the logged-in user.
PUT /reviews/:id β Update an existing review (only rating and comment can be modified).
DELETE /reviews/:id β Remove a review by ID.
𧩠Model
\nEach review record includes:
\nid (primary key)
rating (numeric score)
comment (text feedback)
userId (linked to the logged-in user)
hotelId (linked to the hotel being reviewed)
π Dataset
\nThe backend is seeded with 100+ reviews, providing realistic scenarios for testing hotel ratings, user feedback, and pagination queries.
\nπ Security
\nPublic endpoints allow anyone to browse reviews.
\nPrivate endpoints require authentication, ensuring users can only create, update, or delete their own reviews.
\nThe Images folder contains all endpoints related to hotel images in the Booking App backend. These routes allow authenticated users to upload, list, and delete images associated with hotels, enriching the booking experience with visual content.
\nπ Key Features
\nPrivate access (requires Bearer token):
\nGET /images β Retrieve all hotel images.
POST /images β Upload a new image linked to a hotel.
DELETE /images/:id β Remove an image by ID.
𧩠Model
\nEach image record includes:
\nid (primary key)
url (link to the image resource)
hotelId (reference to the hotel)
π Dataset
\nThe backend is seeded with 300+ hotel images, ensuring diverse and realistic visual data for testing and presentation.
\nπ Security
\nAll image endpoints are private and require authentication.
\nOnly authorized users can manage hotel images.
\n