- Introducción
- Instalación y Configuración
- Estructura de Archivos y Carpetas
- Conceptos Fundamentales
- Flujo de Trabajo en FastAPI
- Comandos Esenciales
- Ejemplo Completo: Aplicación CRUD
- Despliegue en Producción
- Recursos Adicionales
FastAPI es un moderno y rápido (de alto rendimiento) framework web para construir APIs con Python 3.6+ basado en estándares Python. En este README, aprenderemos cómo crear una aplicación CRUD (Create, Read, Update, Delete) utilizando FastAPI.
🚀 FastAPI permite crear APIs RESTful de manera rápida y eficiente, con validación automática, serialización y documentación interactiva.
💻 Desarrollado por Sebastián Ramírez, FastAPI se basa en Starlette para el manejo web y Pydantic para la validación de datos, lo que lo hace extremadamente rápido y fácil de usar.
🔧 FastAPI es ideal para microservicios, aplicaciones serverless, y APIs que requieren alto rendimiento y facilidad de desarrollo.
-
Crear un entorno virtual:
python -m venv venv source venv/bin/activate
-
Instalar FastAPI y dependencias:
pip install fastapi[all] sqlalchemy
fastapi_app/
│
├── main.py
├── config
│ ├── __init__.py
│ └── config_variables.py
|
├── database
│ ├── __init__.py
│ └── database.py
|
├── models/
│ ├── __init__.py
│ └── libro_model.py
|
├── schemas
│ ├── __init__.py
│ └── libro_schema.py
|
├── routes
│ ├── __init__.py
│ └── schema_model.py
│
├── controllers/
│ ├── __init__.py
│ └── libro_controller.py
│
└── db.sqlite3
venv/
: Directorio del entorno virtual de Python.__init__.py
: Archivo que convierte el directorio en un paquete Python.main.py
: Contiene la instancia principal de la aplicación FastAPI y laconfiguración global.config_variables.py
: Guarda las variables de entorno utilizando pydantic_settings.database.py
: Maneja la configuración y conexión a la base de datos.models.py
: Define los modelos de SQLAlchemy que representan las tablas de la base de datos.schemas.py
: Contiene los esquemas Pydantic para la validación de datos yserialización.controllers.py
: Implementa la lógica de negocio y las operaciones CRUD.routes.py
: Define las rutas y endpoints de la API.requirements.txt
: Lista todas las dependencias del proyecto para una fácil instalación.README.md
: Proporciona documentación e instrucciones para el proyecto (este archivo).
-
Crear la estructura de directorios:
mkdir mi_app_crud cd mi_app_crud
Crea las carpetas que necesites y dentro los archivos que vayas a utilizar, la arquitectura de tu proyecto puede cambiar, sin embargo recuerda que queremos escalabilidad, por lo que necesitamos dividir la lógica de los distintos servicios, y la conexiones con otras partes de la aplicación.
-
Configurar las variables de entorno
config/config_variables.py
: Install pydantic_settingspip install pydantic-settings
from pydantic_settings import BaseSettings class Settings(BaseSettings): DB_USER: str = "nombre-del-ddbb-user" DB_PASSWORD: str = "contraseña-ddbb" DB_HOST: str = "ddbb-host" DB_NAME: str = "nombre-ddbb" settings = Settings()
-
Configurar la base de datos en
database/database.py
:# database/database.py from sqlalchemy import create_engine from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker from config.config_variables import settings # Variables de entorno para no exponer información sensible DB_USER = settings.DB_USER DB_PASSWORD = settings.DB_PASSWORD DB_HOST = settings.DB_HOST DB_NAME = settings.DB_NAME # Conexión con la base de datos DATABASE_URL = "mysql+pymysql://"+DB_USER+":"+DB_PASSWORD+"@"+DB_HOST+"/"+DB_NAME+"" # MySQL # Crea un engine engine = create_engine(DATABASE_URL) # Cre una clase para configurar la sesión Session = sessionmaker(autocommit=False, autoflush=False, bind=engine) # Crea una clase base para los modelos Base = declarative_base() # función para obtener la sesión de la base de datos def get_db(): db = Session() # Crea una nueva sesión try: yield db # Usa la sesión finally: db.close() # Cierra la sesión al terminar
- Modelos: Representan las tablas en la base de datos.
- Schemas: Definen la estructura de los datos para la serialización/deserialización.
- CRUD: Operaciones básicas (Create, Read, Update, Delete) para manipular datos.
- Dependencias: Funciones que FastAPI ejecuta antes de las funciones de ruta.
- Pydantic: Biblioteca para validación de datos y configuraciones.
- Definir modelos de base de datos
- Crear schemas Pydantic
- Implementar operaciones CRUD
- Definir rutas de la API
- Configurar la aplicación principal
fastapi run app.py
: Inicia el servidor de desarrollouvicorn app.main:app --reload
: Inicia el servidor de desarrollopytest
: Ejecuta las pruebas (si están configuradas)alembic revision --autogenerate
: Genera una migración de base de datos (si se usa Alembic)alembic upgrade head
: Aplica las migraciones pendientes
from sqlalchemy import Column, Integer, String
from .database import Base
class Item(Base):
__tablename__ = "items"
id = Column(Integer, primary_key=True, index=True)
title = Column(String, index=True)
description = Column(String, index=True)
from pydantic import BaseModel
class ItemBase(BaseModel):
title: str
description: str = None
class ItemCreate(ItemBase):
pass
class Item(ItemBase):
id: int
class Config:
orm_mode = True
from sqlalchemy.orm import Session
from schemas import crud_schema
from models.curd_model import Item
class CrudControllers:
@staticmethod
async def get_item(db: Session, item_id: int):
return db.query(Item).filter(Item.id == item_id).first()
@staticmethod
async def create_item(db: Session, item: crud_schema.ItemCreate):
db_item = Item(**item.dict())
db.add(db_item)
db.commit()
db.refresh(db_item)
return db_item
# Implementar otras operaciones CRUD aquí
from fastapi import APIRouter, Depends
from fastapi import status
from sqlalchemy.orm import Session
from typing import List
from controllers.crud_controller import CrudController
from schemas.attendance_schema import AttendanceSchema
from database.database import get_db
router = APIRouter()
@router.post("/items/", response_model=schemas.Item)
def new_item(item: schemas.ItemCreate, db: Session = Depends(get_db)):
item = await CrudController.create_item(item, db)
return item
@app.get("/items/{item_id}", response_model=schemas.Item)
def read_item(item_id: int, db: Session = Depends(get_db)):
db_item = CrudController.get_item(db, item_id=item_id)
if db_item is None:
raise HTTPException(status_code=404, detail="Item not found")
return db_item
# Implementar otras rutas aquí
from fastapi import FastAPI
from routes.crud_routes import router
app = FastAPI()
#IMPORTANT: Aquí referenciamos el archivo "database" no la variable "db"
from database import database
def run():
pass
if __name__ == '__main__':
database.Base.metadata.create_all(database.engine)
run()
@app.get("/")
async def root():
return {"message": "Hello World"}
app.include_router(router, prefix="/v1")
- Elegir un proveedor de hosting (por ejemplo, Heroku, DigitalOcean, AWS)
- Configurar variables de entorno para la base de datos y otras configuraciones sensibles
- Usar Gunicorn como servidor WSGI para producción
- Configurar un servidor proxy inverso como Nginx (opcional, pero recomendado)
- Implementar HTTPS para seguridad
- Documentación oficial de FastAPI
- Tutorial de SQLAlchemy
- Guía de despliegue de FastAPI
- Curso en video de FastAPI
¡Feliz desarrollo con FastAPI! 🚀