{"id":30746626,"url":"https://github.com/luiggi-piero/shepard-backend","last_synced_at":"2026-04-14T03:32:33.977Z","repository":{"id":305546304,"uuid":"1022886280","full_name":"Luiggi-piero/shepard-backend","owner":"Luiggi-piero","description":"API comercial para el alquiler de habitaciones y departamentos, organizado por roles como USER, ADMIN, GUEST, CLEANING, SECURITY y RECEPTION.","archived":false,"fork":false,"pushed_at":"2025-08-07T21:10:09.000Z","size":115,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-07T23:21:43.425Z","etag":null,"topics":["auth0","java","postgresql","spring-boot","spring-doc-openapi","spring-security"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Luiggi-piero.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-20T04:02:26.000Z","updated_at":"2025-08-07T21:14:29.000Z","dependencies_parsed_at":"2025-08-07T23:14:39.627Z","dependency_job_id":"7ebd2f2b-51ae-42d8-802b-16073df2bffe","html_url":"https://github.com/Luiggi-piero/shepard-backend","commit_stats":null,"previous_names":["luiggi-piero/shepard-backend"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Luiggi-piero/shepard-backend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Luiggi-piero%2Fshepard-backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Luiggi-piero%2Fshepard-backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Luiggi-piero%2Fshepard-backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Luiggi-piero%2Fshepard-backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Luiggi-piero","download_url":"https://codeload.github.com/Luiggi-piero/shepard-backend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Luiggi-piero%2Fshepard-backend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273549251,"owners_count":25125257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auth0","java","postgresql","spring-boot","spring-doc-openapi","spring-security"],"created_at":"2025-09-04T04:02:24.458Z","updated_at":"2026-04-14T03:32:33.948Z","avatar_url":"https://github.com/Luiggi-piero.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"## \u003cp align=\"center\"\u003e SHEPARD API \u003c/p\u003e\n![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)\u003cbr\u003e\nAPI Rest que ofrece servicios de reservación de habitaciones y departamentos desarrollada en Java con Spring Boot, Spring Security, Spring Doc, PostgreSQL, entre otros para la gestión de usuarios(login y registro).\n\n\n## Índice\n\n1. [Funcionalidades](#Funcionalidades)\n2. [Requerimientos previos](#requerimientos-previos)\n3. [Configuración](#configuración)\n4. [Swagger](#swagger)\n5. [Tecnologías utilizadas](#tecnologías-utilizadas)\n6. [Estructura del proyecto](#estructura-del-proyecto)\n7. [Modelo entidad-relación](#modelo-entidad-relación)\n8. [Licencia](#licencia)\n\n\n## Funcionalidades\n\n\n\n\u003cdetails\u003e\n\u003csummary\u003e🔐 Autenticación\u003c/summary\u003e\n\n| Método | Endpoint | Reglas de negocio |\n|--------|----------|-------------------|\n| POST   | `/api/v1/login` | Inicia sesión y obtiene un Token JWT. |\n\n\u003c/details\u003e\n\n\n\n\u003cdetails\u003e\n\u003csummary\u003e👤 Usuarios\u003c/summary\u003e\n\n| Método | Endpoint          | Reglas de negocio |\n|--------|-------------------|-------------------|\n| POST   | `/api/v1/users/register` | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- La API no debe permitir el registro de usuarios duplicados (con el mismo correo) y debe tener al menos un número y una letra mayúscula.\u003cbr\u003e- Asignar el rol USER por defecto.\u003cbr\u003e- La API debe retornar la información del nuevo usuario y el token. \u003cbr\u003e- Si elige el rol RECEPTION, la propiedad receptionist es necesaria y de forma similar para el rol CLEANING con la propiedad cleaningStaff. \u003cbr\u003e- Si el correo ya existe retornar un código HTTP 409. \u003cbr\u003e- Si la contraseña tiene menos de 8 o más de 15 caracteres retornar un 400.\u003cbr\u003e- Si la contraseña no tiene al menos un letra mayúscula y un número retornar un 400.|\n| GET    | `/users`          | - Retornar los primeros 10 resultados ordenados por id.\u003cbr\u003e- Devolver todos los atributos menos la contraseña.\u003cbr\u003e- Obtener la respuesta con paginación para controlar el volumen de los datos.\u003cbr\u003e- Solo el rol ADMIN puede obtener todos los usuarios. |\n| GET    | `/api/v1/users/{id}`     | - Retornar el usuario que coincida con el id y que además se encuentre habilitado.\u003cbr\u003e- Si no encuentra el usuario retornar un 404.\u003cbr\u003e- Solo el rol ADMIN puede buscar usuarios. |\n| UPDATE | `/api/v1/users/{id}`     | - Si no se completan los campos obligatorios retorna un 400.\u003cbr\u003e- Si no encuentra el usuario retornar un 404.\u003cbr\u003e- Solo el rol ADMIN puede actualizar usuarios. \u003cbr\u003e- Si elige el rol RECEPTION, la propiedad receptionist es necesaria y de forma similar para el rol CLEANING con la propiedad cleaningStaff. \u003cbr\u003e- Si el correo ya existe retornar un código HTTP 409. \u003cbr\u003e- Si la contraseña tiene menos de 8 o más de 15 caracteres retornar un 400.\u003cbr\u003e- Si la contraseña no tiene al menos un letra mayúscula y un número retornar un 400.|\n| DELETE  | `/api/v1/users/{id}`     | - Si la eliminación es exitosa retornar un 204.\u003cbr\u003e- Si no encuentra el usuario retornar un 404.\u003cbr\u003e- Solo el rol ADMIN puede eliminar usuarios. |\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e🏢 Departamentos\u003c/summary\u003e\n\n| Método | Endpoint          | Reglas de negocio |\n|--------|-------------------|-------------------|\n| POST   | `/api/v1/departments` | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN tienen acceso \u003cbr\u003e- La API debe retornar la información del nuevo departamento. \u003cbr\u003e- Si la creación es exitosa retorna el código HTTP 201.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400.\n| GET    | `/api/v1/departments`          | - Retornar los primeros 10 resultados ordenados por code.\u003cbr\u003e- Obtener la respuesta con paginación para controlar el volumen de los datos.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION pueden obtener todos los usuarios. \u003cbr\u003e- El tamaño por defecto de la página será de 10|\n| GET    | `/api/v1/departments/{id}`     | - Retornar el departamento que coincida con el id y que además se encuentre habilitado.\u003cbr\u003e- Si no encuentra el departamento retornar un 404.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION puede buscar usuarios.|\n| UPDATE | `/api/v1/departments/{id}`     | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN tienen acceso \u003cbr\u003e- La API debe retornar la información del departamento actualizado. \u003cbr\u003e- Si la edición es exitosa retorna el código HTTP 200.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400. \u003cbr\u003e - Si el departamento no se encuentra retornar el código HTTP 404.|\n| DELETE  | `/api/v1/departments/{id}`     | - Si la eliminación es exitosa retornar un 204.\u003cbr\u003e- Si no encuentra el departamento retornar un 404.\u003cbr\u003e- Solo el rol ADMIN puede eliminar departamentos. |\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e🚪 Habitaciones\u003c/summary\u003e\n\n| Método | Endpoint          | Reglas de negocio |\n|--------|-------------------|-------------------|\n| POST   | `/api/v1/rooms` | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN tienen acceso \u003cbr\u003e- La API debe retornar la información de la nueva habitación. \u003cbr\u003e- Si la creación es exitosa retorna el código HTTP 201.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400. \u003cbr\u003e - Si no se encuentra el tipo de habitación retornar un 404.\n| GET    | `/api/v1/rooms`          | - Retornar los primeros 10 resultados ordenados por number.\u003cbr\u003e- Obtener la respuesta con paginación para controlar el volumen de los datos.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION pueden obtener todas las habitaciones. \u003cbr\u003e- El tamaño por defecto de la página será de 10.|\n| GET    | `/api/v1/rooms/{id}`     | - Retornar la habitación que coincida con el id y que además se encuentre habilitado.\u003cbr\u003e- Si no encuentra el departamento retornar un 404.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION puede buscar habitaciones.|\n| UPDATE | `/api/v1/rooms/{id}`     | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN tienen acceso \u003cbr\u003e- La API debe retornar la información de la habitación actualizada. \u003cbr\u003e- Si la edición es exitosa retorna el código HTTP 200.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400. \u003cbr\u003e - Si no se encuentra la habitación o el tipo de habitación retornar un 404.|\n| DELETE  | `/api/v1/rooms/{id}`     | - Si la eliminación es exitosa retornar un 204.\u003cbr\u003e- Si no encuentra la habitación retornar un 404.\u003cbr\u003e- Solo el rol ADMIN puede eliminar habitaciones. |\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\u003csummary\u003e📅 Reservas\u003c/summary\u003e\n\n| Método | Endpoint          | Reglas de negocio |\n|--------|-------------------|-------------------|\n| POST   | `/api/v1/bookings` | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN o RECEPTION tienen acceso a este endpoint. \u003cbr\u003e- La API debe retornar la información de la nueva reserva. \u003cbr\u003e- Si la creación es exitosa retorna el código HTTP 201.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400. \u003cbr\u003e - Si no se encuentra huésped, recepcionista o el alojamiento retornar un 404. \u003cbr\u003e - Verifica que no exista algún conflicto de tiempos entre la nueva reserva y las existentes.\n| GET    | `/api/v1/bookings`          | - Retornar los primeros 10 resultados ordenados por fecha de creación.\u003cbr\u003e- Obtener la respuesta con paginación para controlar el volumen de los datos.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION pueden obtener todas las reservas. \u003cbr\u003e- El tamaño por defecto de la página será de 10. \u003cbr\u003e - Es posible realizar búsquedas con filtros como: ID del huésped, ID del recepcionista, estado de la reserva, nombre del huésped y fechas|\n| GET    | `/api/v1/bookings/{id}`     | - Retornar la reserva que coincida con el id y que además se encuentre habilitado.\u003cbr\u003e- Si no encuentra la reserva retornar un 404.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION puede buscar habitaciones.|\n| UPDATE | `/api/v1/bookings/{id}`     | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN o RECEPTION tienen acceso a este endpoint. \u003cbr\u003e- La API debe retornar la información de la reserva actualizada. \u003cbr\u003e- Si la edición es exitosa retorna el código HTTP 200.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400. \u003cbr\u003e - Si no se encuentra huésped, recepcionista o el alojamiento retornar un 404. \u003cbr\u003e - Verificar que no exista algún conflicto de tiempos entre la nueva reserva y las existentes. \u003cbr\u003e - Si no encuentra la reserva retornar el código HTTP 404.|\n| DELETE  | `/api/v1/bookings/{id}`     | - Si la eliminación es exitosa retornar un 204.\u003cbr\u003e- Si no encuentra la reserva retornar un 404.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION puede eliminar reservas. |\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e🏨 Tipos de habitaciones\u003c/summary\u003e\n\n| Método | Endpoint          | Reglas de negocio |\n|--------|-------------------|-------------------|\n| POST   | `/api/v1/room-types` | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN tienen acceso a este endpoint. \u003cbr\u003e- La API debe retornar la información del nuevo tipo de habitación. \u003cbr\u003e- Si la creación es exitosa retorna el código HTTP 201.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400.\n| GET    | `/api/v1/room-types`          | - Retornar los primeros 10 resultados ordenados por el nombre.\u003cbr\u003e- Obtener la respuesta con paginación para controlar el volumen de los datos.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION pueden obtener todos los tipos de habitaciones. \u003cbr\u003e- El tamaño por defecto de la página será de 10.|\n| GET    | `/api/v1/room-types/{id}`     | - Retornar el tipo de habitación que coincida con el id y que además se encuentre habilitado.\u003cbr\u003e- Si no lo encuentra retornar un 404.\u003cbr\u003e- Solo el rol ADMIN y RECEPTION puede buscar los tipos de habitaciones.|\n| UPDATE | `/api/v1/room-types/{id}`     | - Verificar si todos los campos obligatorios se están ingresando correctamente.\u003cbr\u003e- Solo usuarios con rol ADMIN tienen acceso a este endpoint. \u003cbr\u003e- La API debe retornar la información actualizada. \u003cbr\u003e- Si la actualización es exitosa retorna el código HTTP 200.\u003cbr\u003e- Si los datos son inválidos retornar el código HTTP 400. \u003cbr\u003e - Si no se encuentra el recurso retornar el código HTTP 404.|\n| DELETE  | `/api/v1/room-types/{id}`     | - Si la eliminación es exitosa retornar un 204.\u003cbr\u003e- Si no encuentra el recurso retornar un 404.\u003cbr\u003e- Solo el rol ADMIN puede eliminar. |\n\n\u003c/details\u003e\n\n## Requerimientos previos\n\n- **JDK: Java 21 o superior**\n- **Gestor de dependencias: Maven 4.0.0**\n- **Spring Boot 3.3.5**\n- **Base de datos PostgreSQL (cambiar la configuración de application.properties)**\n\n## Configuración \n\n  1. Clona el repositorio\n     \n     ```bash\n     git clone https://github.com/Luiggi-piero/shepard-backend.git\n     cd shepard-backend\n  2. Configura las variables de entorno para la conexión a la base de datos desde `application-prod.yml`\n\n     ```yaml\n     spring:\n      datasource:\n        url: ${DB_URL:jdbc:postgresql://localhost:5432/shepard_db}\n        username: ${DB_USER}\n        password: ${DB_PASS}\n        driver-class-name: org.postgresql.Driver\n      jpa:\n    \n        hibernate:\n          ddl-auto: update\n        show-sql: true\n    \n      server:\n        port: 8080\n    \n      konecta:\n        cors:\n          allowed-origins: \"*\"\n          allowed-methods: \"GET,POST,PUT,DELETE,OPTIONS\"\n          allowed-headers: \"*\"\n    \n      security:\n        secret: ${JWT_SECRET}  # Get from env vars\n        expiration-ms: ${JWT_EXPIRATION_MS:86400000}\n\n  3. Crea un base de datos vacía con el nombre shepard_db\n  \n  4. Ejecuta el proyecto\n\n  5. La aplicación estará disponible en: http://localhost:8080\n\n## Swagger\nSwagger está configurado para generar documentación de la API automáticamente. Puedes acceder a la interfaz de Swagger en la siguiente URL cuando el servidor esté en funcionamiento:\n```\nhttp://localhost:8080/swagger-ui/index.html\n```\n\u003cimg width=\"1897\" height=\"904\" alt=\"image\" src=\"https://github.com/user-attachments/assets/e49827bd-6ca4-4c58-a1af-01fcf49f4974\" /\u003e\n\n\n\n## Tecnologías utilizadas\n\n- **Spring Boot**: Desarrollo rápido y robusto de aplicaciones.\n- **Spring Security y JWT**: Autenticación segura.\n- **PostgreSQL**: Sistema de gestión de bases de datos relacional.          \n\n\n## Estructura del proyecto\n\nArquitectura basada en paquetes funcionales, se organizan  las carpetas de acuerdo con las características o módulos de la aplicación (por ejemplo, auth, category, challenge), es un diseño entre aspectos funcionales y principios de Clean Architecture y este tipo de arquitectura agrupa cada módulo con sus propios componentes como controladores, servicios, repositorios y modelos.\n\n      src\n      └── main\n          ├── java/com/example/skilllinkbackend\n          │   ├── config       \n          │   |   ├── exceptions       -\u003e Exception handling.\n          |   |   ├── responses        -\u003e Response format.\n          |   |   ├── security         -\u003e Security settings.\n          |   |   └── springdoc        -\u003e Spring doc configuration.\n          │   ├── features\n          │   |   ├── auth             -\u003e Authentication.\n          |   |   ├── accommodation\n          |   |   ├── booking\n          |   |   ├── bookingitem\n          |   |   ├── cleaningstaff\n          |   |   ├── department\n          |   |   ├── receptionist\n          |   |   ├── room\n          |   |   ├── roomtype\n          |   |   ├── securitystaff\n          |   |   ├── role   \n          |   |   └── usuario \n          |   └── shared                     \n          │      ├── enums\n          │      ├── roledeletionhandler\n          |      ├── roleregistrationhandler        \n          |      └── util             -\u003e Reusable items.\n          └── resources\n              └── application.properties -\u003e Configuration app.\n        \n\n## Modelo Entidad Relación\n\u003cimg width=\"2091\" height=\"676\" alt=\"Image\" src=\"https://github.com/user-attachments/assets/662c86aa-7744-4b40-833a-842643040558\" /\u003e\n\n\u003c/br\u003e\n\n## Licencia\nEste proyecto está licenciado bajo la Licencia MIT. Consulta el archivo LICENSE para más detalles.\n\u003c/br\u003e\u003c/br\u003e\n\n\u003e [!IMPORTANT]\n\u003e * Con sql crea los roles: USER, ADMIN, GUEST, CLEANING, RECEPTION y SECURITY  en la tabla roles\n\u003e * Cambia a enabled 1 todos los roles\n\u003e * Registra un usuario con los roles necesarios\n\u003e * Agrega la configuración de la bd en `application-prod.yml`\n\u003e * Para aquellos que no tienen la zona horaria GMT-5 modificar el archivo ...TokenService (para indicar la expiración del token)\n         \n\n\u003c/br\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/java-white?style=for-the-badge\u0026logo=openjdk\u0026logoColor=white\u0026labelColor=black\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/SPRINGBOOT-white?style=for-the-badge\u0026logo=spring\u0026logoColor=white\u0026labelColor=%236DB33F\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/mysql-white?style=for-the-badge\u0026logo=mysql\u0026logoColor=white\u0026labelColor=4169E1\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/postgresql-white?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white\u0026labelColor=4169E1\"\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluiggi-piero%2Fshepard-backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluiggi-piero%2Fshepard-backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluiggi-piero%2Fshepard-backend/lists"}