README.md

---
title: Fastapi Mariadb
emoji: 🐠
colorFrom: pink
colorTo: indigo
sdk: docker
pinned: false
license: bigscience-openrail-m
---

# FastAPI + MariaDB

Proyecto que conecta FastAPI con una base de datos MariaDB usando `mysql-connector-python`.

## 📋 Requisitos previos

- Python 3.8+
- MariaDB instalado y ejecutándose
- pip (gestor de paquetes de Python)

## 🚀 Instalación

### 1. Clonar o descargar el proyecto

```bash
cd c:\Moibe\code\fastapi-mariadb
```

### 2. Crear un entorno virtual (recomendado)

```bash
python -m venv venv
venv\Scripts\activate
```

### 3. Instalar dependencias

```bash
pip install -r requirements.txt
```

### 4. Configurar variables de entorno

Copia el archivo `.env.example` a `.env` y completa tus credenciales:

```bash
copy .env.example .env
```

Edita `.env` con tus datos de conexión:

```env
DB_HOST=localhost
DB_USER=tu_usuario
DB_PASSWORD=tu_contraseña
DB_NAME=nombre_base_datos
DB_PORT=3306
```

## 🔧 Cómo funciona

### 1. Variables de entorno (`.env`)
Se cargan automáticamente usando `python-dotenv`:
- `DB_HOST` - Host del servidor MariaDB
- `DB_USER` - Usuario de la base de datos
- `DB_PASSWORD` - Contraseña
- `DB_NAME` - Nombre de la base de datos
- `DB_PORT` - Puerto (por defecto 3306)

### 2. Función `get_connection()` en `connection.py`
- Carga las variables de entorno
- Usa `mysql.connector` para conectar a MariaDB
- Retorna la conexión o `None` si falla
- Tiene `autocommit=True` para ejecutar cambios automáticamente

### 3. Endpoints en `main.py`
Cada endpoint utiliza la conexión así:

```python
conn = get_connection()
if not conn:
    raise HTTPException(status_code=500, detail="Error de conexión")

cursor = conn.cursor()
cursor.execute("SELECT ...")
resultado = cursor.fetchone()
cursor.close()
conn.close()
```

## ▶️ Ejecutar la aplicación

```bash
python main.py
```

La API estará disponible en: `http://localhost:8000`

## 📚 Endpoints disponibles

### `GET /`
Endpoint raíz de bienvenida.

**Respuesta:**
```json
{
  "mensaje": "Bienvenido a FastAPI con MariaDB"
}
```

### `GET /test-conexion`
Prueba la conexión a la base de datos.

**Respuesta (exitosa):**
```json
{
  "status": "success",
  "mensaje": "Conexión exitosa",
  "mariadb_version": "10.6.8-MariaDB"
}
```

### `GET /datos`
Obtiene datos de la tabla configurada.

**Respuesta:**
```json
{
  "status": "success",
  "cantidad": 5,
  "datos": [...]
}
```

## 📖 Documentación interactiva

Una vez que la aplicación esté corriendo, accede a:

- **Swagger UI**: http://localhost:8000/docs
- **ReDoc**: http://localhost:8000/redoc

## 🔐 Notas de seguridad

- **NUNCA** subas el archivo `.env` a control de versiones
- El `.gitignore` ya contiene `.env` para protegerte
- En producción, usa variables de entorno del sistema operativo
- Considera usar secretos seguros para credenciales

## 🐛 Solución de problemas

### Error: "Could not find module 'mysql.connector'"
Asegúrate de instalar las dependencias:
```bash
pip install -r requirements.txt
```

### Error: "Connection refused"
Verifica que:
- MariaDB está corriendo
- Las credenciales en `.env` son correctas
- El host y puerto son correctos

### Error: "Unknown database"
Verifica que la base de datos existe y que el usuario tiene permisos.

## 📝 Próximos pasos

1. Ajusta `connection.py` si necesitas parámetros adicionales
2. Modifica los endpoints en `main.py` según tus necesidades
3. Crea modelos Pydantic para validación de datos
4. Implementa autenticación si es necesario

## 📄 Licencia

Este proyecto es de código abierto. Siéntete libre de modificarlo según tus necesidades.
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference