Smart Hotel API

A RESTful API built with Express for the Smart Hotel project

French README • Project Overview • Getting Started • API Documentation

Table of Contents

• Table of Contents
• Project Overview
• Technologies Used
• Getting Started
  • Requirements
  • Installation
  • Configuration
  • Running the API Locally
  • Development Database with Docker
• API Documentation
  • Authentication
  • Available Routes

Project Overview

The Smart Hotel API is the backend for mobile app and web app of the Smart Hotel project, a second-year project in cybersecurity, computer science and networks. It is designed to manage the hotel's bar orders and environmental sensors.

Technologies Used

• Node.js
• Express
• PostgreSQL
• Argon2
• JSON Web Token
• Docker

Getting Started

Requirements

• Node.js (>=22.9.0 for development)
• PostgreSQL (if not using Docker)
• Docker (for containerized development)

Installation

1. Clone the repository:

git clone https://github.com/alexwauquier/smart-hotel-api.git

2. Navigate to the project directory:

cd smart-hotel-api

3. Install dependencies:

npm install

Configuration

This project includes a default .env.development file. You can override this by adding your own environment variables to the .env.development.local file. The application will automatically load variables from both files, with the .env.development.local file taking priority.

Variable	Description	Default value
API_BASE_URL	Base URL of the API	http://127.0.0.1:3000
PORT	Port on which the API will run	3000
DB_USER	Database username	smarthotel
DB_PASSWORD	Database password	smarthotel
DB_HOST	Database host	localhost
DB_PORT	Database port	5432
DB_NAME	Database name	smart_hotel_db
JWT_SECRET	JWT secret key	smarthotel

Running the API Locally

To start the API in development mode with automatic restarts:

npm run start:dev

The API will be available at http://localhost:3000.

Development Database with Docker

For local development, a PostgreSQL database can be set up using Docker Compose. A compose.development.yaml file is provided for this setup.

To start the database:

docker compose -f compose.development.yaml up -d

This will launch a PostgreSQL container with the required configuration for testing the API.

API Documentation

Authentication

This API uses JWT-based authentication. To access protected routes, add the token in the Authorization header:

Authorization: Bearer <your_token_here>

Available Routes

Authentication

Method	Endpoint	Description
POST	/api/auth/login/customer	Authenticates a customer and returns a JWT token
POST	/api/auth/login/employee	Authenticates an employee and returns a JWT token

Customers

Method	Endpoint	Description
GET	/api/customers	Returns a list of customers
GET	/api/customers/:customerId	Returns a single customer
GET	/api/customers/:customerId/orders	Returns customer orders
POST	/api/customers	Creates a new customer
PATCH	/api/customers/:customerId	Updates an existing customer
DELETE	/api/customers/:customerId	Deletes a customer

Employees

Method	Endpoint	Description
GET	/api/employees	Returns a list of employees
GET	/api/employees/:employeeId	Returns a single employee
POST	/api/employees	Creates a new employee
PATCH	/api/employees/:employeeId	Updates an existing employee
DELETE	/api/employees/:employeeId	Deletes an employee

Employee Types

Method	Endpoint	Description
GET	/api/employees/types	Returns all employee types
GET	/api/employees/types/:typeId	Returns a single employee type
POST	/api/employees/types	Creates a new employee type
PATCH	/api/employees/types/:typeId	Updates an existing employee type
DELETE	/api/employees/types/:typeId	Deletes an employee

Orders

Method	Endpoint	Description
GET	/api/orders	Returns a list of orders
GET	/api/orders/:orderId	Returns a single order
POST	/api/orders	Creates a new order
PATCH	/api/orders/:orderId/status	Updates the status of an order

Order Statuses

Method	Endpoint	Description
GET	/api/orders/statuses	Returns all order statuses
GET	/api/orders/statuses/:statusId	Returns a single order status
POST	/api/orders/statuses	Creates a new order status
PATCH	/api/orders/statuses/:statusId	Updates an order status
DELETE	/api/orders/statuses/:statusId	Deletes an order status

Products

Method	Endpoint	Description
GET	/api/products	Returns a list of products
GET	/api/products/:productId	Returns a single product
POST	/api/products	Creates a new product
PATCH	/api/products/:productId	Updates an existing product
DELETE	/api/products/:productId	Deletes a product

Product Types

Method	Endpoint	Description
GET	/api/products/types	Returns all product types
GET	/api/products/types/:typeId	Returns a single product type
POST	/api/products/types	Creates a new product type
PATCH	/api/products/types/:typeId	Updates an existing product type
DELETE	/api/products/types/:typeId	Deletes a product type

Sensors

Method	Endpoint	Description
GET	/api/sensors	Returns a list of sensors
GET	/api/sensors/:sensorsId	Returns a single sensor
GET	/api/sensors/:sensorsId/measurements	Returns sensor measurements
POST	/api/sensors/:sensorsId/measurements	Creates a sensor measurement
POST	/api/sensors	Creates a new sensor
PATCH	/api/sensors/:sensorsId	Updates an existing sensor
DELETE	/api/sensors/:sensorsId	Deletes a sensor

Sensor Types

Method	Endpoint	Description
GET	/api/sensors/types	Returns all sensor types
GET	/api/sensors/types/:typeId	Returns a single sensor type
POST	/api/sensors/types	Creates a new sensor type
PATCH	/api/sensors/types/:typeId	Updates an existing sensor type
DELETE	/api/sensors/types/:typeId	Deletes a sensor type

Spaces

Method	Endpoint	Description
GET	/api/spaces	Returns a list of spaces
GET	/api/spaces/:spaceId	Returns a single space
POST	/api/spaces	Creates a new space
PATCH	/api/spaces/:spaceId	Updates an existing space
DELETE	/api/spaces/:spaceId	Deletes a space

Space Types

Method	Endpoint	Description
GET	/api/spaces/types	Returns all space types
GET	/api/spaces/types/:typeId	Returns a single space type
POST	/api/spaces/types	Creates a new space type
PATCH	/api/spaces/types/:typeId	Updates an existing space type
DELETE	/api/spaces/types/:typeId	Deletes a space type