FastAPI

Descripción general

FastAPI es un framework web de Python moderno y de alto rendimiento para crear APIs. Ofrece documentación interactiva automática, validación con type hints y soporte asíncrono de serie.

Inicio rápido

git clone https://<git-server>/<username>/<repo-name>.git
cd <repo-name>

pip install -r requirements.txt

uvicorn app.main:app --reload

git add .
git commit -m "Initial setup"
git push origin main

Desarrollo local con Docker

Si no tienes Python instalado localmente, puedes usar Docker para ejecutar tu aplicación FastAPI.

Ejecutar comandos con Docker

# Install dependencies
docker run --rm -v $(pwd):/app -w /app python:3.12 pip install -r requirements.txt

# Run development server
docker run --rm -v $(pwd):/app -w /app -p 8000:8000 python:3.12 sh -c "pip install -r requirements.txt && uvicorn app.main:app --host 0.0.0.0 --reload"

Configuración de la base de datos

La plataforma NStrim te proporciona una base de datos MySQL/MariaDB. Configura tu conexión en el archivo .env o directamente en tu módulo de configuración de la base de datos.

DATABASE_URL=mysql+pymysql://<username>:<password>@db.<session-domain>:3306/<username>

Estructura del proyecto

├── app/
│   ├── main.py                # Punto de entrada de la app FastAPI
│   ├── routers/               # Módulos de rutas
│   ├── models/                # Modelos SQLAlchemy
│   ├── schemas/               # Esquemas Pydantic
│   └── database.py            # Conexión a la base de datos
├── templates/                 # Plantillas Jinja2
├── static/                    # CSS, JS, imágenes
├── requirements.txt           # Dependencias Python
└── Dockerfile                 # Configuración Docker
        

Tareas comunes

Crear un endpoint de la API

from fastapi import APIRouter

router = APIRouter()

@router.get("/users")
async def get_users():
    return [{"name": "Alice"}, {"name": "Bob"}]

@router.post("/users")
async def create_user(name: str, email: str):
    return {"name": name, "email": email}

Usar SQLAlchemy

from sqlalchemy import Column, Integer, String
from app.database import Base

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String(100))
    email = Column(String(255), unique=True)

Esquema Pydantic para validación

from pydantic import BaseModel

class UserCreate(BaseModel):
    name: str
    email: str

class UserResponse(BaseModel):
    id: int
    name: str
    email: str

    class Config:
        from_attributes = True

Comandos útiles

Resolución de problemas

Flujo de despliegue