bernat13/mariadb2apirest repository overview

⁠Dynamic MariaDB to REST API

Este proyecto genera automáticamente una API REST completa (CRUD) y documentación Swagger basándose en el esquema de una base de datos MariaDB existente.

⁠Características

• 🚀 Generación Dinámica: No requiere configuración de esquemas manual. Lee las tablas directamente de la base de datos.
• 📄 Swagger UI: Documentación interactiva disponible en /api-docs.
• 🐳 Docker Ready: Listo para desplegar en contenedores.
• 🔓 Sin Autenticación: (Como solicitado) La API es pública.

⁠Variables de Entorno

El contenedor se configura mediante las siguientes variables de entorno:

⁠🛠️ Uso con Docker

⁠Opción 1: Docker Run (Contenedor Individual)

Si ya tienes una base de datos corriendo, puedes ejecutar el contenedor directamente descargando la imagen desde Docker Hub.

⁠Escenarios de Conexión:

⁠⚠️ ¿Por qué no puedo usar localhost a secas?

Esta es la duda más común. Dentro de un contenedor, localhost se refiere al propio contenedor, no a tu ordenador.

Si tu base de datos está instalada "en el Windows/Linux/Mac" (fuera de Docker) y pones DB_HOST=localhost, la API buscará la base de datos dentro de su propio contenedor y no la encontrará.

¿Cómo solucionarlo?

1. Windows/Mac: Usa host.docker.internal. Docker mapea esto automáticamente a tu máquina real.
2. Linux: Tienes dos opciones:
   • Añadir --network="host" al arrancar el contenedor. Esto hace que el contenedor comparta la red con tu máquina y entonces sí funciona localhost.
   • Usar la IP real de tu máquina (ej. 192.168.1.X).
3. Entre Contenedores: Si la base de datos también es un contenedor, usa el nombre del contenedor (ej: DB_HOST=mi-mariadb-container). Para esto, ambos deben estar en la misma red de Docker (docker network connect).

⁠Ejemplo de ejecución:

docker run -d \
  --name mariadb-api \
  -p 3000:3000 \
  -e DB_HOST=192.168.1.50 \
  -e DB_USER=root \
  -e DB_PASSWORD=tu_password \
  -e DB_NAME=tu_base_de_datos \
  bernat13/mariadb2apirest:latest

Una vez arrancado:

• API: http://localhost:3000/{nombre_tabla}
• Documentación Swagger: http://localhost:3000/api-docs⁠

⁠📖 Documentación Interactiva (Swagger)

Una de las joyas de este proyecto es que genera automáticamente una interfaz de Swagger UI.

1. Abre tu navegador en: http://localhost:3000/api-docs.
2. Verás todos los "endpoints" agrupados por tablas.
3. Puedes probar la API directamente haciendo clic en "Try it out" en cada endpoint. No necesitas herramientas externas como Postman para empezar.

⁠🛒 Ejemplo Práctico: Una Tienda Online

Imagina que tu base de datos MariaDB tiene las siguientes tablas: productos, clientes y pedidos. La API generará automáticamente estas rutas para ti:

⁠1. Gestión de Productos

• GET /productos: Lista todos los productos disponibles.
• POST /productos: Registra un nuevo producto.
• GET /productos/5: Obtiene el detalle del producto con ID 5.
• PUT /productos/5: Actualiza el precio o stock del producto 5.
• DELETE /productos/5: Elimina el producto 5.

⁠2. Ejemplo de consulta (cURL)

Si quieres obtener todos los productos de tu tienda desde la terminal:

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

⁠3. Ejemplo de creación (JSON)

Para añadir un nuevo producto enviando un JSON al endpoint:

curl -X POST http://localhost:3000/productos \
     -H "Content-Type: application/json" \
     -d '{"nombre": "Teclado Mecánico", "precio": 89.99, "stock": 15}'

⁠Opción 2: Docker Compose (Configuración Standalone)

Esta es la forma recomendada para mantener tu stack organizado. En este modo la API se conecta a una base de datos que ya tienes funcionando.

Crea un archivo docker-compose.yml:

version: '3.8'

services:
  api:
    image: bernat13/mariadb2apirest:latest
    container_name: dynamic-api
    restart: always
    ports:
      - "3000:3000"
    environment:
      DB_HOST: host.docker.internal # O la IP de tu base de datos
      DB_PORT: 3306
      DB_USER: root
      DB_PASSWORD: rootpassword
      DB_NAME: mydatabase
      PORT: 3000

⁠Pasos para probar:

1. Ejecuta:

   docker-compose up -d
   

   Copy
2. Conéctate a la BBDD con tu cliente SQL (localhost:3306, user: root, pass: rootpassword).
3. Crea una tabla de prueba:

   USE mydatabase;
   CREATE TABLE usuarios (
     id INT AUTO_INCREMENT PRIMARY KEY,
     nombre VARCHAR(50),
     email VARCHAR(50)
   );
   INSERT INTO usuarios (nombre, email) VALUES ('Juan', '[email protected]');
   

   Copy
4. Reinicia la API para que detecte la nueva tabla (ya que el escaneo ocurre al arrancar):

   docker restart dynamic-api
   

   Copy

⁠🚀 Caso Específico: Conectar a mariadb_container

Según tu configuración actual, para conectar la API a tu contenedor MariaDB ya existente:

1. Asegúrate de que el archivo docker-compose.yml tiene la red mariadb_default marcada como externa:

   networks:
     mariadb_default:
       external: true
   

   Copy
2. La API usará DB_HOST=mariadb_container y la contraseña 54321Ba##.
3. Levanta la API con:

   docker-compose up -d
   

   Copy