Skip to content

Latest commit

 

History

History
107 lines (73 loc) · 2.63 KB

README.md

File metadata and controls

107 lines (73 loc) · 2.63 KB
Raw

Spring Boot Hotel Booking API

This Spring Boot application demonstrates a simple hotel booking system with CRUD functionality, utilizing an H2 in-memory database for data persistence. This README provides instructions on setting up and running the application, as well as connecting to the H2 database console for data verification and testing.

Getting Started

These instructions will guide you through setting up and running the application on your local machine.

Prerequisites

Ensure you have the following installed:

  • JDK 17 or newer
  • Maven
  • An IDE (e.g., IntelliJ IDEA, VS Code)

Setup and Run

  1. Clone the repository

    Open your terminal and run:

    git clone https://gitlab.com/ranitraj/Spring-HotelManagementSystem.git
cd Spring-HotelManagementSystem

  2. Build the project

    Using Maven:

    mvn clean install

  3. Run the application

    Execute the following command:

    mvn spring-boot:run

    The application will start and be accessible at http://localhost:8080.

Accessing the H2 Database Console

The H2 database console is enabled by default and can be accessed through your web browser for direct database interactions:

  1. Navigate to http://localhost:8080/h2-console in your browser.
  2. Use the following settings to connect:
    • JDBC URL: jdbc:h2:mem:booking_db
    • User Name: sa
    • Password: (leave this blank)
  3. Click Connect to access the database console.

Testing API Endpoints

You can test the API endpoints using Postman or any other API testing tool by sending requests to http://localhost:8080/bookings. Below are sample requests for each available endpoint.

Create a New Booking

  • Method: POST

  • URL: /bookings

  • Body:

    {
  "customerName": "John Doe",
  "roomType": "Deluxe",
  "checkInDate": "2024-02-08 00:00:00",
  "checkOutDate": "2024-02-10 00:00:00",
  "totalPrice": 250.0
}

Retrieve All Bookings

  • Method: GET
  • URL: /bookings

Retrieve a Booking by ID

  • Method: GET
  • URL: /bookings/{id}

Update a Booking

  • Method: PUT

  • URL: /bookings/{id}

  • Body: (Modify as needed)

    {
  "customerName": "Jane Doe Updated",
  "roomType": "Suite",
  "checkInDate": "2024-02-09 00:00:00",
  "checkOutDate": "2024-02-11 00:00:00",
  "totalPrice": 300.0
}

Built With