Para revisar la misma aplicación pero desarrollada con Backend Javascript haga clic aquí
MVP de la API de un hotel que permite:
- Conocer la fecha de ingreso y acompañantes de los clientes
- Conocer los servicios consumidos dentro del hotel por cada cliente
- Calcular el valor total a pagar al momento del checkout
- Se implementa una mejora en la arquitectura del servicio utilizando el patrón DAO
- Se cuenta con una documentación integrada accediendo en los endpoints /api/v2/docs y /api/v2/docs-ui
- Se implementó testing del servicio de servicios ofrecidos por el hotel.
La base de datos se encuentra diseñada de la siguiente manera
Clientes: Tabla en la que se almacena la información personal de los clientes
| Campo | Descripción | Notas |
|---|---|---|
| id | Identificador único | Llave primaria, autoincremental |
| cedula | Número de identificación | único |
| nombre | Nombre del cliente | - |
| correo | correo del cliente | - |
| telefono | Teléfono del cliente | - |
Grupos: Tabla en la que se almacena la información sobre los grupos, número para agrupar a personas que se registren juntas. La idea es que si viene un grupo de personas se cree un grupo en la base de datos y posteriormente este sea asignado a todos los clientes que se registren juntos. Si una persona viene sola, debe tener asignado un grupo nuevo.
| Campo | Descripción | Notas |
|---|---|---|
| id | Identificador único | Llave primaria, autoincremental |
| total_integrantes | Cantidad total de personas registradas con el identificador | - |
Servicios: Tabla en la que se almacena la información sobre los servicios que ofrece el hotel
| Campo | Descripción | Notas |
|---|---|---|
| id | Identificador único | Llave primaria, autoincremental |
| identificador | Combinación de letras alusivas, identificador alfanumérico | único |
| descripción | Breve explicación del servicio | Máximo 70 caracteres |
| precio | Cuanto se cobrará por el servicio | - |
Ingresos: Tabla en la que se almacena la información sobre las personas que se registran en el hotel. Se hizo de manera separada porque un cliente puede ingresar varias veces al hotel.
| Campo | Descripción | Notas |
|---|---|---|
| id | Identificador único | Llave primaria, autoincremental |
| id_grupo | Identificador del grupo con el que viene | - |
| cedula | Cedula del cliente | Debe estar previamente registrado en la tabla clientes |
| fecha_ingreso | Fecha de ingreso al hotel | - |
| fecha_salida | Fecha de salida del hotel | - |
| total_consumo | Total a pagar una vez finalizada la estadía | - |
Registros: Tabla en la que se almacena la información sobre el consumo de servicios por parte los clientes ingresados.
| Campo | Descripción | Notas |
|---|---|---|
| id | Identificador único | Llave primaria, autoincremental |
| fecha | Fecha en la que se toma el servicio | - |
| cedula | Cedula del cliente | Debe estar previamente registrado en la tabla clientes |
| servicio | Identificador del servicio | Debe coincidir con algún servicio de la tabla servicios |
A continuación una imagen del modelo:
En la carpeta bd puede encontrar el script sql para configurar la base de datos
| Método | Url | Descripción |
|---|---|---|
| POST | /api/v2/servicios | Agrega otro servicio a la tabla servicios |
| GET | /api/v2/servicios | Obtienes todos los servicios ofrecidos por el hotel |
| GET | /api/v2/servicios/tipo/{tipo} | Obtienes todos los servicios clasificados por el tipo especificado |
| GET | /api/v2/servicios/id/{id} | Obtiene el servicio que coincida con el id especificado |
| PUT | /api/v2/servicios/id/{id} | Modifica el servicio identificado con el id especificado con los datos del servicio recibido en el body |
| DELETE | /api/v2/servicios/id/{id} | Elimina el servicio identificado con el id especificado |
| GET | /api/v2/servicios/identificador/{identificador} | Obtiene el servicio que coincida con el identificador especificado |
| PUT | /api/v2/servicios/identificador/{identificador} | Modifica el servicio identificado con el identificador especificado con los datos del servicio recibido en el body |
| DELETE | /api/v2/servicios/identificador/{identificador} | Elimina el servicio identificado con el identificador especificado |
| Método | Url | Descripción |
|---|---|---|
| POST | /api/v2/clientes | Agrega otro cliente a la tabla clientes |
| GET | /api/v2/clientes | Obtienes todos los clientes registrados en el hotel |
| GET | /api/v2/clientes/id/{id} | Obtiene el cliente que coincide con el id especificado |
| PUT | /api/v2/cliente/id/{id} | Modifica el cliente identificado con el id especificado con los datos del cliente recibido en el body |
| GET | /api/v2/clientes/checkout/id/{id} | Obtiene un objeto con la cantidad total que debe pagar el cliente identificado con el id especificado hasta el momento, un mensaje y actualiza de manera automatica el campo total_consumo en el registro de la tabla de ingreso correspondiente |
| DELETE | /api/v2/clientes/id/{id} | Elimina el cliente identificado con el id especificado |
| GET | /api/v2/clientes/cc/{cc} | Obtiene el cliente que coincida con la cedula especificada |
| GET | /api/v2/clientes/checkout/cc/{cc} | Obtiene un objeto con la cantidad total que debe pagar el cliente identificado con la cedula especificada hasta el momento, un mensaje y actualiza de manera automatica el campo total_consumo en el registro de la tabla de ingreso correspondiente |
| PUT | /api/v2/clientes/cc/{cc} | Modifica el cliente identificado con la cedula especificada con los datos del cliente recibido en el body |
| DELETE | /api/v2/clientes/cc/{cc} | Elimina el cliente identificado con la cedula especificada |
| Método | Url | Descripción |
|---|---|---|
| POST | /api/v2/grupos | Agrega otro grupo a la tabla grupos |
| GET | /api/v2/grupos | Obtienes todos los grupos registrados en el hotel |
| GET | /api/v2/grupos/id/{id} | Obtiene el grupo que coincide con el id especificado |
| PUT | /api/v2/grupos/id/{id} | Modifica el grupo identificado con el id especificado con los datos del grupo recibido en el body |
| DELETE | /api/v2/grupos/id/{id} | Elimina el grupo identificado con el id especificado |
| Método | Url | Descripción |
|---|---|---|
| POST | /api/v2/registros?cedula={cedulaCliente}&servicio={identificadorServicio} | Agrega otro registro a la tabla registros |
| GET | /api/v2/registros | Obtienes todos los registros |
| GET | /api/v2/registros/id/{id} | Obtiene el registro que corresponde al id especificado |
| GET | /api/v2/registros/cliente/{cc_cliente} | Obtiene todos los registros de un cliente |
| GET | /api/v2/registros/servicio/{servicio} | Obtiene todos los registros del identificador del servicio especificado |
| PUT | /api/v2/registros/id/{id} | Modifica el registro identificado con el id especificado con los datos del registro recibido en el body |
| DELETE | /api/v2/registros/id/{id} | Elimina el registro identificado con el id especificado |
| Método | Url | Descripción |
|---|---|---|
| POST | /api/v2/ingresos | Agrega otro ingreso a la tabla ingresos |
| GET | /api/v2/ingresos | Obtienes todos los ingresos |
| GET | /api/v2/ingresos/grupo/{grupo} | Obtiene todos los ingresos de un grupo, todas las personas que se registraron juntas |
| GET | /api/v2/ingresos/cc/{cc} | Obtiene todos los ingresos de cliente |
| GET | /api/v2/ingresos/id/{id} | Obtiene el registro identificado con el id especificado |
| PUT | /api/v2/ingresos/id/{id} | Modifica el ingreso identificado con el id especificado con los datos del ingreso recibido en el body |
| DELETE | /api/v2/registros/id/{id} | Elimina el registro identificado con el id especificado |
| DELETE | /api/v2/registros/cc/{cc} | Elimina todos los ingresos de un cliente identificado con la cedula especificada |
| Método | Url | Descripción |
|---|---|---|
| GET | /api/v2/docs | Documentación en formato json |
| GET | /api/v2/docs-ui | Documentación con interfaz de usuario |
Para levantar la aplicación
-
Descargue el proyecto y ábralo con su editor de texto preferido, se recomienda IntelliJ
-
Configure la base de datos en MySQL Workbench utilizando el documento sql que encontrará en la carpeta bd con el nombre bdMyHotel.sql
-
Cambie las credenciales correspondientes en el archivo app.properties
-
Levante el servidor
-
Utilizando un cliente http, se recomienda Postman realice las pruebas de la API
El proyecto se encuentra desplegado en AWS haciendo uso de los servicios:
- AWS RDS
- AWS Elastic Bean Stack
La url para acceder y realizar pruebas en vivo con la api es http://apimyhotel-env.eba-aeaeep3n.us-east-2.elasticbeanstalk.com/
Para realizar las pruebas de la API se sugiere seguir el siguiente flujo
- Crear un nuevo cliente o varios, especificando el body de la peticion POST (revisar el apartado API)
{
"cedula": "1111111111",
"nombre": "Pepito Perez",
"correo": "pepito@test.com",
"telefono": "3125697856"
}
- Crear un nuevo grupo especificando la cantidad de clientes que van juntos
{
"total_integrantes": 1,
}
- Crear los ingresos correspondientes a los clientes, verificar el id del grupo creado en caso de no recordarlo con la peticion GET correspondiente
{
"id_grupo":1,
"cedula": "1111111111",
"fecha_ingreso": "2022-01-15T07:37:36.476+00:00",
"fecha_salida": "",
"total_consumo": 0
}
-
Crear registros simulando la compra de servicios por parte de los clientes
Nota: Si no configuró la base de datos utilizando el sql especificado debe hacer el proceso de creacion de servicios
{
"id_ingreso":1,
"cedula": "1111111111",
"fecha": "2022-01-15T06:29:19.810+00:00",
"servicio": "GYM"
}
- Obtener el total a pagar por el usuario haciendo la peticion get checkout
Puede continuar interactuando con todos los métodos especificados en el apartado API en su máquina local o hacer las pruebas con el servidor en la nube**
**Sujeto a disponibilidad del servicio
Cualquier duda comentario o sugerencia es bienvenido. Puede enviarme un email a elianachavezv@gmail.com