Bienvenido a la API MacJava, desarrollada por Jaime Lozano, Diego Torres, Oscar Encabo y Kelvin Sánchez. Esta API proporciona una gestión segura y completa de bases de datos, diseñada para tiendas online, y está basada en el framework SpringBoot.
- Introducción
- GitFlow
- Dependencias
- Bases de Datos
- Características Comunes de los Endpoints
- Categorías
- Trabajadores y Clientes
- Restaurantes y Productos
- Autenticación
- Usuarios
- Pedidos
- Despliegue
- Tests
La API MacJava ofrece una administración segura y completa de bases de datos, diseñada para tiendas online. Basada en SpringBoot, destaca por su facilidad de configuración y rápido desarrollo. Se sigue la metodología GitFlow para la gestión de ramas, con ramas de características integradas en una rama de desarrollo y fusionadas en una rama principal después de pruebas.
Se ha seguido la metodología GitFlow para la organización del proyecto, con ramas de características fusionadas en una rama de desarrollo, integrando cambios de manera segura.
Las dependencias incluyen SpringBoot (con varias características), bases de datos como PostgreSQL y H2, Lombok, Swagger, Jackson y JWT. Consulta la sección de dependencias para obtener detalles completos.
Para el desarrollo, se utiliza H2, que funciona en memoria y facilita la configuración de datos. En producción, se emplea PostgreSQL por su robustez y escalabilidad.
Se detallan características comunes en los modelos, UUIDs y autonuméricos, DTOs, Mappers, Excepciones, Repositorios, Servicios y Controladores. Los métodos comunes incluyen findAll, findById, save, update y deleteById. Se utiliza caché para mejorar el rendimiento.
El endpoint de categorías gestiona roles (puestos) con detalles como id, nombre limitado, y salario base.
Estos endpoints comparten comportamiento. Solo los trabajadores y administradores pueden realizar cambios en las bases de datos. El programa está diseñado para cobertura local y presencial, con planes de expansión para compras online.
Estos endpoints ofrecen control mixto: acciones permitidas para todos y acciones solo para administradores. Se manejan respuestas detalladas y códigos de estado.
El endpoint de autenticación permite registrarse e iniciar sesión. Se utiliza JWT para gestionar tokens y autenticar usuarios.
Este endpoint administra información de usuarios, con detalles tanto para administradores como para usuarios. Las contraseñas se codifican para mayor seguridad.
Este endpoint es el más complejo, gestionando pedidos de restaurantes, clientes y trabajadores. Utiliza MongoDB para almacenar pedidos, con clases específicas para productos pedidos y pedidos.
El despliegue se realiza mediante Docker, facilitando la distribución y permitiendo ajustes de configuración con archivos Dockerfile y docker-compose.
Se han creado pruebas de caja negra y caja blanca con JUnit y Mockito para verificar el correcto funcionamiento de la aplicación.