🍳 YummiAPI - Plataforma de Recetas Culinarias

API REST desarrollada con Node.js, Express, MongoDB y Dotenv para una plataforma de recetas culinarias donde los usuarios pueden registrarse, agregar recetas con ingredientes, y buscar recetas por ingrediente.

Video : https://youtu.be/KGJ0hbasVx4

🚀 Características

Gestión de usuarios: Registro, consulta, actualización y eliminación
Gestión de recetas: Creación, edición, eliminación y consulta por usuario
Gestión de ingredientes: Agregar ingredientes a recetas, buscar recetas por ingrediente
Búsqueda avanzada: Encontrar recetas que contengan ingredientes específicos
Datos de prueba: Script de inicialización con datos de ejemplo

🛠️ Tecnologías

Node.js - Runtime de JavaScript
Express - Framework web
MongoDB - Base de datos NoSQL
Dotenv - Gestión de variables de entorno

📋 Prerrequisitos

Node.js (versión 14 o superior)
MongoDB (local o en la nube)
npm o yarn

🔧 Instalación

Clonar el repositorio
```
git clone <repository-url>
cd YummiAPI
```
Instalar dependencias
```
npm install
```

Configurar variables de entorno Crear un archivo .env en la raíz del proyecto:

PORT=3000
HOST_NAME=localhost
MONGO_URI=mongodb://localhost:27017
DB_NAME=yummi_recetas

Inicializar datos de prueba
```
node src/dataset.js
```

Ejecutar el servidor

# Desarrollo
npm run dev

# Producción
npm start

📚 Documentación de la API

Base URL

http://localhost:3000

Health Check

GET /health

Respuesta:

{
  "message": "API de Recetas Culinarias activa!!! 🍳"
}

👥 Gestión de Usuarios

1. Obtener todos los usuarios

GET /usuarios

Descripción: Obtiene una lista completa de todos los usuarios registrados en la plataforma. Este endpoint es útil para administradores que necesitan ver un panorama general de la base de usuarios.

Parámetros: Ninguno

Headers requeridos: Ninguno

Respuesta exitosa (200):

{
  "message": "Usuarios obtenidos exitosamente",
  "count": 3,
  "usuarios": [
    {
      "id": 1,
      "nombre": "María García",
      "email": "maria.garcia@email.com",
      "fechaRegistro": "2024-01-15T10:30:00Z"
    }
  ]
}

Casos de uso:

Panel de administración para ver todos los usuarios
Estadísticas generales de la plataforma
Verificación de usuarios registrados

Posibles errores:

500 - Error interno del servidor si hay problemas con la base de datos

2. Obtener usuario por ID

GET /usuarios/:id

Descripción: Obtiene la información detallada de un usuario específico mediante su ID único. Este endpoint es fundamental para perfiles de usuario y operaciones que requieren verificar la existencia de un usuario.

Parámetros de ruta:

id (number, requerido): ID único del usuario a consultar

Headers requeridos: Ninguno

Respuesta exitosa (200):

{
  "message": "Usuario obtenido exitosamente",
  "usuario": {
    "id": 1,
    "nombre": "María García",
    "email": "maria.garcia@email.com",
    "fechaRegistro": "2024-01-15T10:30:00Z"
  }
}

Casos de uso:

Perfil de usuario en la interfaz
Verificación de usuario antes de crear recetas
Validación de permisos de usuario
Dashboard personalizado

Posibles errores:

404 - Usuario no encontrado si el ID no existe
500 - Error interno del servidor

Ejemplo de uso con curl:

curl -X GET http://localhost:3000/usuarios/1

3. Crear nuevo usuario

POST /usuarios

Descripción: Registra un nuevo usuario en la plataforma. Este endpoint valida que el ID sea único y que se proporcionen todos los campos obligatorios. La fecha de registro se asigna automáticamente.

Headers requeridos:

Content-Type: application/json

Body (JSON, requerido):

{
  "id": 4,
  "nombre": "Carlos Rodríguez",
  "email": "carlos.rodriguez@email.com"
}

Campos del body:

id (number, requerido): ID único del usuario (debe ser único en el sistema)
nombre (string, requerido): Nombre completo del usuario
email (string, requerido): Dirección de correo electrónico del usuario

Respuesta exitosa (201):

{
  "message": "Usuario creado exitosamente",
  "usuario": {
    "id": 4,
    "nombre": "Carlos Rodríguez",
    "email": "carlos.rodriguez@email.com",
    "fechaRegistro": "2024-02-15T10:30:00Z"
  }
}

Casos de uso:

Registro de nuevos usuarios en la plataforma
Migración de usuarios desde otros sistemas
Creación de usuarios de prueba

Posibles errores:

400 - Faltan campos obligatorios o datos inválidos
400 - Ya existe un usuario con ese ID
500 - Error interno del servidor

Ejemplo de uso con curl:

curl -X POST http://localhost:3000/usuarios \
  -H "Content-Type: application/json" \
  -d '{"id": 4, "nombre": "Carlos Rodríguez", "email": "carlos.rodriguez@email.com"}'

Validaciones implementadas:

Verificación de campos obligatorios (id, nombre, email)
Validación de unicidad del ID
Asignación automática de fecha de registro

4. Actualizar usuario

PATCH /usuarios/:id

Parámetros:

id (number): ID del usuario

Body:

{
  "nombre": "María García López",
  "email": "maria.lopez@email.com"
}

Respuesta:

{
  "message": "Usuario actualizado exitosamente"
}

5. Eliminar usuario

DELETE /usuarios/:id

Parámetros:

id (number): ID del usuario

Respuesta:

{
  "message": "Usuario y todas sus recetas eliminados exitosamente"
}

🍳 Gestión de Recetas

1. Obtener todas las recetas

GET /recetas

Descripción: Obtiene una lista completa de todas las recetas disponibles en la plataforma. Este endpoint es ideal para mostrar un catálogo general de recetas o para operaciones de búsqueda y filtrado.

Parámetros: Ninguno

Headers requeridos: Ninguno

Respuesta exitosa (200):

{
  "message": "Recetas obtenidas exitosamente",
  "count": 4,
  "recetas": [
    {
      "id": 1,
      "titulo": "Pasta Carbonara",
      "descripcion": "Deliciosa pasta italiana con huevo, queso parmesano y panceta",
      "usuarioId": 1,
      "fechaCreacion": "2024-01-16T12:00:00Z",
      "ingredientes": []
    }
  ]
}

Campos de respuesta:

message (string): Mensaje de confirmación
count (number): Número total de recetas encontradas
recetas (array): Lista de objetos receta con información básica

Casos de uso:

Catálogo general de recetas
Página principal de la aplicación
Estadísticas de la plataforma
Operaciones de búsqueda y filtrado

Posibles errores:

500 - Error interno del servidor si hay problemas con la base de datos

Ejemplo de uso con curl:

curl -X GET http://localhost:3000/recetas

2. Obtener receta por ID (con ingredientes)

GET /recetas/:id

Descripción: Obtiene la información completa de una receta específica, incluyendo todos sus ingredientes. Este endpoint es fundamental para mostrar el detalle de una receta en la interfaz de usuario.

Parámetros de ruta:

id (number, requerido): ID único de la receta a consultar

Headers requeridos: Ninguno

Respuesta exitosa (200):

{
  "message": "Receta obtenida exitosamente",
  "receta": {
    "id": 1,
    "titulo": "Pasta Carbonara",
    "descripcion": "Deliciosa pasta italiana con huevo, queso parmesano y panceta",
    "usuarioId": 1,
    "fechaCreacion": "2024-01-16T12:00:00Z",
    "ingredientes": [
      {
        "id": 1,
        "nombre": "Pasta",
        "recetaId": 1,
        "fechaAgregado": "2024-01-16T12:05:00Z"
      },
      {
        "id": 2,
        "nombre": "Huevos",
        "recetaId": 1,
        "fechaAgregado": "2024-01-16T12:05:00Z"
      }
    ]
  }
}

Campos de respuesta:

message (string): Mensaje de confirmación
receta (object): Objeto con información completa de la receta
- id (number): ID único de la receta
- titulo (string): Título de la receta
- descripcion (string): Descripción detallada
- usuarioId (number): ID del usuario propietario
- fechaCreacion (string): Fecha de creación en formato ISO 8601
- ingredientes (array): Lista de ingredientes con información completa

Casos de uso:

Página de detalle de receta
Vista de receta completa para cocinar
Verificación de ingredientes antes de comprar
Compartir receta con otros usuarios

Posibles errores:

404 - Receta no encontrada si el ID no existe
500 - Error interno del servidor

Ejemplo de uso con curl:

curl -X GET http://localhost:3000/recetas/1

Notas técnicas:

Este endpoint realiza una consulta adicional para obtener los ingredientes
Los ingredientes se ordenan por fecha de agregado
La respuesta incluye información completa para renderizado en frontend

3. Obtener recetas de un usuario específico

GET /recetas/usuario/:usuarioId

Parámetros:

usuarioId (number): ID del usuario

Respuesta:

{
  "message": "Recetas del usuario 1 obtenidas exitosamente",
  "count": 2,
  "recetas": [
    {
      "id": 1,
      "titulo": "Pasta Carbonara",
      "descripcion": "Deliciosa pasta italiana con huevo, queso parmesano y panceta",
      "usuarioId": 1,
      "fechaCreacion": "2024-01-16T12:00:00Z",
      "ingredientes": []
    },
    {
      "id": 3,
      "titulo": "Ensalada César",
      "descripcion": "Ensalada fresca con lechuga, pollo, queso parmesano y aderezo especial",
      "usuarioId": 1,
      "fechaCreacion": "2024-01-25T11:20:00Z",
      "ingredientes": []
    }
  ]
}

4. Crear nueva receta

POST /recetas

Body:

{
  "id": 5,
  "titulo": "Risotto de Hongos",
  "descripcion": "Cremoso risotto italiano con hongos porcini",
  "usuarioId": 2
}

Respuesta:

{
  "message": "Receta creada exitosamente",
  "receta": {
    "id": 5,
    "titulo": "Risotto de Hongos",
    "descripcion": "Cremoso risotto italiano con hongos porcini",
    "usuarioId": 2,
    "fechaCreacion": "2024-02-15T10:30:00Z",
    "ingredientes": []
  }
}

5. Actualizar receta

PATCH /recetas/:id

Parámetros:

id (number): ID de la receta

Body:

{
  "titulo": "Pasta Carbonara Tradicional",
  "descripcion": "Auténtica receta italiana de pasta carbonara con guanciale"
}

Respuesta:

{
  "message": "Receta actualizada exitosamente"
}

6. Eliminar receta

DELETE /recetas/:id

Parámetros:

id (number): ID de la receta

Respuesta:

{
  "message": "Receta y todos sus ingredientes eliminados exitosamente"
}

🥕 Gestión de Ingredientes

1. Obtener ingredientes de una receta

GET /ingredientes/receta/:recetaId

Parámetros:

recetaId (number): ID de la receta

Respuesta:

{
  "message": "Ingredientes de la receta 1 obtenidos exitosamente",
  "count": 5,
  "ingredientes": [
    {
      "id": 1,
      "nombre": "Pasta",
      "recetaId": 1,
      "fechaAgregado": "2024-01-16T12:05:00Z"
    },
    {
      "id": 2,
      "nombre": "Huevos",
      "recetaId": 1,
      "fechaAgregado": "2024-01-16T12:05:00Z"
    }
  ]
}

2. Agregar ingrediente a una receta

POST /ingredientes

Body:

{
  "id": 22,
  "nombre": "Aceite de Oliva",
  "recetaId": 1
}

Respuesta:

{
  "message": "Ingrediente agregado exitosamente",
  "ingrediente": {
    "id": 22,
    "nombre": "Aceite de Oliva",
    "recetaId": 1,
    "fechaAgregado": "2024-02-15T10:30:00Z"
  }
}

3. Eliminar ingrediente de una receta

DELETE /ingredientes/:id/receta/:recetaId

Parámetros:

id (number): ID del ingrediente
recetaId (number): ID de la receta

Respuesta:

{
  "message": "Ingrediente eliminado exitosamente"
}

4. Buscar recetas por ingrediente

GET /ingredientes/buscar?nombre=pollo

Descripción: Busca todas las recetas que contengan un ingrediente específico. Esta es una funcionalidad clave que permite a los usuarios encontrar recetas basándose en ingredientes que tienen disponibles. La búsqueda es case-insensitive y utiliza expresiones regulares para coincidencias parciales.

Parámetros de consulta:

nombre (string, requerido): Nombre del ingrediente a buscar (búsqueda parcial, case-insensitive)

Headers requeridos: Ninguno

Respuesta exitosa (200):

{
  "message": "Recetas encontradas con el ingrediente 'pollo'",
  "count": 3,
  "recetas": [
    {
      "id": 2,
      "titulo": "Pollo al Curry",
      "descripcion": "Pollo cocinado con especias y leche de coco",
      "usuarioId": 2,
      "fechaCreacion": "2024-01-21T18:30:00Z",
      "ingredientesEncontrados": [
        {
          "id": 6,
          "nombre": "Pollo",
          "recetaId": 2,
          "fechaAgregado": "2024-01-21T18:35:00Z"
        }
      ]
    },
    {
      "id": 3,
      "titulo": "Ensalada César",
      "descripcion": "Ensalada fresca con lechuga, pollo, queso parmesano y aderezo especial",
      "usuarioId": 1,
      "fechaCreacion": "2024-01-25T11:20:00Z",
      "ingredientesEncontrados": [
        {
          "id": 12,
          "nombre": "Pollo",
          "recetaId": 3,
          "fechaAgregado": "2024-01-25T11:25:00Z"
        }
      ]
    }
  ]
}

Campos de respuesta:

message (string): Mensaje descriptivo con el ingrediente buscado
count (number): Número total de recetas encontradas
recetas (array): Lista de recetas que contienen el ingrediente
- ingredientesEncontrados (array): Lista de ingredientes que coinciden con la búsqueda

Casos de uso:

Búsqueda de recetas por ingredientes disponibles
Sugerencias de recetas basadas en ingredientes
Filtrado de recetas por ingredientes específicos
Funcionalidad "¿Qué puedo cocinar con...?"

Posibles errores:

400 - Parámetro 'nombre' no proporcionado
500 - Error interno del servidor

Ejemplos de búsqueda:

# Búsqueda exacta
curl "http://localhost:3000/ingredientes/buscar?nombre=pollo"

# Búsqueda parcial (encuentra "pollo", "pollo al", etc.)
curl "http://localhost:3000/ingredientes/buscar?nombre=pol"

# Búsqueda case-insensitive
curl "http://localhost:3000/ingredientes/buscar?nombre=POLLO"

Características técnicas:

Búsqueda case-insensitive: "pollo", "POLLO", "Pollo" dan los mismos resultados
Búsqueda parcial: "pol" encuentra "pollo", "polenta", etc.
Expresiones regulares: Utiliza MongoDB regex para búsquedas flexibles
Optimización: Consulta eficiente que evita cargar todas las recetas

Casos de prueba recomendados:

nombre=pollo → 3 recetas
nombre=queso → 2 recetas
nombre=cebolla → 2 recetas
nombre=arroz → 0 recetas (si no hay recetas con arroz)

🧪 Ejemplos de Uso

Flujo completo de uso:

Crear un usuario:

curl -X POST http://localhost:3000/usuarios \
  -H "Content-Type: application/json" \
  -d '{"id": 5, "nombre": "Chef Master", "email": "chef@email.com"}'

Crear una receta:

curl -X POST http://localhost:3000/recetas \
  -H "Content-Type: application/json" \
  -d '{"id": 6, "titulo": "Paella Valenciana", "descripcion": "Auténtica paella española", "usuarioId": 5}'

Agregar ingredientes:

curl -X POST http://localhost:3000/ingredientes \
  -H "Content-Type: application/json" \
  -d '{"id": 23, "nombre": "Arroz", "recetaId": 6}'

Buscar recetas con arroz:

curl "http://localhost:3000/ingredientes/buscar?nombre=arroz"

🔍 Códigos de Estado HTTP

200 - OK (operación exitosa)
201 - Created (recurso creado)
400 - Bad Request (datos inválidos)
404 - Not Found (recurso no encontrado)
500 - Internal Server Error (error del servidor)

🚨 Manejo de Errores

La API devuelve mensajes de error claros en formato JSON:

{
  "error": "Usuario no encontrado"
}

📝 Notas Importantes

Los IDs deben ser únicos dentro de cada colección
Al eliminar un usuario, se eliminan automáticamente todas sus recetas
Al eliminar una receta, se eliminan automáticamente todos sus ingredientes
La búsqueda de ingredientes es case-insensitive
Todos los timestamps están en formato ISO 8601

🎬 Guía de Demostración Paso a Paso

Preparación Inicial

Iniciar el servidor:
```
npm run dev
```
Verificar que el servidor esté funcionando:
- Abrir: http://localhost:3000/health
- Debe mostrar: {"message": "API de Recetas Culinarias activa!!! 🍳"}
Inicializar datos de prueba:
```
npm run seed
```

Flujo de Demostración Completo

PASO 1: Verificar Datos Iniciales

1.1 - Listar todos los usuarios

GET http://localhost:3000/usuarios

Resultado: 3 usuarios (María García, Juan Pérez, Ana López)

1.2 - Listar todas las recetas

GET http://localhost:3000/recetas

Resultado: 4 recetas iniciales

PASO 2: Gestión de Usuarios

2.1 - Obtener usuario específico

GET http://localhost:3000/usuarios/1

Resultado: Información de María García

2.2 - Crear nuevo usuario

POST http://localhost:3000/usuarios
Content-Type: application/json

{
  "id": 4,
  "nombre": "Chef Master",
  "email": "chef.master@email.com"
}

2.3 - Actualizar usuario

PATCH http://localhost:3000/usuarios/4
Content-Type: application/json

{
  "nombre": "Chef Master Pro",
  "email": "chef.pro@email.com"
}

PASO 3: Gestión de Recetas

3.1 - Crear nueva receta

POST http://localhost:3000/recetas
Content-Type: application/json

{
  "id": 5,
  "titulo": "Risotto de Hongos",
  "descripcion": "Cremoso risotto italiano con hongos porcini",
  "usuarioId": 4
}

3.2 - Obtener receta con ingredientes

GET http://localhost:3000/recetas/1

Resultado: Pasta Carbonara con sus 5 ingredientes

3.3 - Listar recetas de un usuario específico

GET http://localhost:3000/recetas/usuario/1

Resultado: 2 recetas de María García

PASO 4: Gestión de Ingredientes

4.1 - Agregar ingredientes a la nueva receta

POST http://localhost:3000/ingredientes
Content-Type: application/json

{
  "id": 22,
  "nombre": "Arroz Arborio",
  "recetaId": 5
}

4.2 - Ver ingredientes de una receta

GET http://localhost:3000/ingredientes/receta/1

Resultado: 5 ingredientes de Pasta Carbonara

PASO 5: BÚSQUEDA POR INGREDIENTE 🔍

5.1 - Buscar recetas con "pollo"

GET http://localhost:3000/ingredientes/buscar?nombre=pollo

Resultado: 3 recetas que contienen pollo

5.2 - Buscar recetas con "queso"

GET http://localhost:3000/ingredientes/buscar?nombre=queso

Resultado: 2 recetas con queso parmesano

5.3 - Buscar recetas con "cebolla"

GET http://localhost:3000/ingredientes/buscar?nombre=cebolla

Resultado: 2 recetas con cebolla

PASO 6: LISTADO DE RECETAS POR USUARIO 👤

6.1 - Recetas de María García (usuario 1)

GET http://localhost:3000/recetas/usuario/1

Resultado: 2 recetas (Pasta Carbonara y Ensalada César)

6.2 - Recetas de Juan Pérez (usuario 2)

GET http://localhost:3000/recetas/usuario/2

Resultado: 1 receta (Pollo al Curry)

6.3 - Recetas de Ana López (usuario 3)

GET http://localhost:3000/recetas/usuario/3

Resultado: 1 receta (Tacos de Pollo)

PASO 7: Operaciones de Eliminación

7.1 - Eliminar ingrediente

DELETE http://localhost:3000/ingredientes/24/receta/5

7.2 - Eliminar receta

DELETE http://localhost:3000/recetas/5

7.3 - Eliminar usuario

DELETE http://localhost:3000/usuarios/4

🎯 Casos de Prueba Especiales

Búsquedas por Ingrediente:

"pollo" → 3 recetas encontradas
"queso" → 2 recetas encontradas
"cebolla" → 2 recetas encontradas
"arroz" → 0 recetas (después de eliminar)

Recetas por Usuario:

Usuario 1 (María) → 2 recetas
Usuario 2 (Juan) → 1 receta
Usuario 3 (Ana) → 1 receta

📱 Configuración en Insomnia/Postman

Variables de entorno recomendadas:

base_url: http://localhost:3000
usuario_id: 1
receta_id: 1

Headers necesarios:

Content-Type: application/json

Colecciones sugeridas:

Usuarios (5 endpoints)
Recetas (6 endpoints)
Ingredientes (4 endpoints)
Búsquedas (búsqueda por ingrediente)

✅ Funcionalidades Demostradas:

✅ Gestión completa de usuarios (CRUD)
✅ Gestión completa de recetas (CRUD)
✅ Gestión completa de ingredientes (CRUD)
✅ Búsqueda por ingrediente (case-insensitive)
✅ Listado de recetas por usuario
✅ Eliminación en cascada (usuario → recetas → ingredientes)
✅ Validaciones y manejo de errores

🔧 Documentación Técnica Avanzada

Arquitectura de la API

Patrón MVC Implementado:

Controllers → Services → Database
     ↓           ↓         ↓
  Routes    Business    MongoDB
           Logic

Estructura de Respuestas:

Todas las respuestas siguen un patrón consistente:

{
  "message": "Descripción de la operación",
  "count": 0,           // Solo en listas
  "data": {},           // Datos específicos
  "error": "Mensaje"    // Solo en errores
}

Validaciones Implementadas

Usuarios:

✅ ID único en el sistema
✅ Campos obligatorios: id, nombre, email
✅ Validación de formato de email
✅ Prevención de duplicados

Recetas:

✅ ID único en el sistema
✅ Campos obligatorios: id, titulo, descripcion, usuarioId
✅ Verificación de existencia del usuario propietario
✅ Validación de longitud de campos

Ingredientes:

✅ ID único por receta
✅ Campos obligatorios: id, nombre, recetaId
✅ Verificación de existencia de la receta
✅ Prevención de duplicados por receta

Optimizaciones de Rendimiento

Consultas Eficientes:

Índices recomendados en MongoDB:

// Índices para optimizar consultas
db.usuarios.createIndex({ "id": 1 })
db.recetas.createIndex({ "id": 1 })
db.recetas.createIndex({ "usuarioId": 1 })
db.ingredientes.createIndex({ "recetaId": 1 })
db.ingredientes.createIndex({ "nombre": "text" })

Estrategias de Caching:

Respuestas de listas pueden ser cacheadas por 5 minutos
Búsquedas frecuentes pueden usar cache Redis
Headers de cache recomendados para endpoints GET

Manejo de Errores Avanzado

Códigos de Estado HTTP:

200 - Operación exitosa
201 - Recurso creado exitosamente
400 - Datos de entrada inválidos
404 - Recurso no encontrado
500 - Error interno del servidor

Estructura de Errores:

{
  "error": "Mensaje descriptivo del error",
  "code": "ERROR_CODE",
  "details": "Información adicional para debugging"
}

Seguridad y Buenas Prácticas

Validación de Entrada:

Sanitización de strings para prevenir inyecciones
Validación de tipos de datos
Límites de longitud en campos de texto

Headers de Seguridad Recomendados:

X-Content-Type-Options: nosniff
X-Frame-Options: DENY
X-XSS-Protection: 1; mode=block

Monitoreo y Logging

Métricas Recomendadas:

Tiempo de respuesta por endpoint
Número de requests por minuto
Errores por tipo y endpoint
Uso de memoria y CPU

Logs Estructurados:

{
  "timestamp": "2024-02-15T10:30:00Z",
  "level": "INFO",
  "endpoint": "GET /recetas",
  "responseTime": 150,
  "statusCode": 200
}

Escalabilidad

Consideraciones para Alto Tráfico:

Implementar rate limiting por IP
Usar connection pooling para MongoDB
Considerar sharding por usuarioId para recetas
Implementar paginación en listas grandes

Límites Recomendados:

Máximo 1000 usuarios por página
Máximo 500 recetas por página
Máximo 50 ingredientes por receta
Timeout de 30 segundos por request

🤝 Contribución

Fork el proyecto
Crea una rama para tu feature (git checkout -b feature/AmazingFeature)
Commit tus cambios (git commit -m 'Add some AmazingFeature')
Push a la rama (git push origin feature/AmazingFeature)
Abre un Pull Request

📄 Licencia

Este proyecto está bajo la Licencia ISC.

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
src		src
README.md		README.md
TALLER COMPLETO.TXT		TALLER COMPLETO.TXT
package-lock.json		package-lock.json
package.json		package.json

DanielSantiagoV/YummiAPI

Folders and files

Latest commit

History

Repository files navigation

🍳 YummiAPI - Plataforma de Recetas Culinarias

Video : https://youtu.be/KGJ0hbasVx4

🚀 Características

🛠️ Tecnologías

📋 Prerrequisitos

🔧 Instalación

📚 Documentación de la API

Base URL

Health Check

👥 Gestión de Usuarios

1. Obtener todos los usuarios

2. Obtener usuario por ID

3. Crear nuevo usuario

4. Actualizar usuario

5. Eliminar usuario

🍳 Gestión de Recetas

1. Obtener todas las recetas

2. Obtener receta por ID (con ingredientes)

3. Obtener recetas de un usuario específico

4. Crear nueva receta

5. Actualizar receta

6. Eliminar receta

🥕 Gestión de Ingredientes

1. Obtener ingredientes de una receta

2. Agregar ingrediente a una receta

3. Eliminar ingrediente de una receta

4. Buscar recetas por ingrediente

🧪 Ejemplos de Uso

Flujo completo de uso:

🔍 Códigos de Estado HTTP

🚨 Manejo de Errores

📝 Notas Importantes

🎬 Guía de Demostración Paso a Paso

Preparación Inicial

Flujo de Demostración Completo

PASO 1: Verificar Datos Iniciales

PASO 2: Gestión de Usuarios

PASO 3: Gestión de Recetas

PASO 4: Gestión de Ingredientes

PASO 5: BÚSQUEDA POR INGREDIENTE 🔍

PASO 6: LISTADO DE RECETAS POR USUARIO 👤

PASO 7: Operaciones de Eliminación

🎯 Casos de Prueba Especiales

Búsquedas por Ingrediente:

Recetas por Usuario:

📱 Configuración en Insomnia/Postman

Variables de entorno recomendadas:

Headers necesarios:

Colecciones sugeridas:

✅ Funcionalidades Demostradas:

🔧 Documentación Técnica Avanzada

Arquitectura de la API

Patrón MVC Implementado:

Estructura de Respuestas:

Validaciones Implementadas

Usuarios:

Recetas:

Ingredientes:

Optimizaciones de Rendimiento

Consultas Eficientes:

Estrategias de Caching:

Manejo de Errores Avanzado

Códigos de Estado HTTP:

Estructura de Errores:

Seguridad y Buenas Prácticas

Validación de Entrada:

Headers de Seguridad Recomendados:

Monitoreo y Logging

Métricas Recomendadas:

Logs Estructurados:

Escalabilidad

Consideraciones para Alto Tráfico:

Límites Recomendados:

🤝 Contribución

📄 Licencia

Packages