¿Qué tipos de respuesta puedes devolver más allá de JSON?

Question

Accepted Answer

FastAPI devuelve JSON por defecto (serializando dicts, lists y modelos Pydantic), pero soporta muchos otros **tipos de respuesta** para diferentes necesidades — HTML, archivos, streams, redirecciones y texto plano — a través de las clases `fastapi.responses`. ## Las clases de respuesta predeterminadas y comunes ```python from fastapi.responses import ( JSONResponse, HTMLResponse, PlainTextResponse, RedirectResponse, FileResponse, StreamingResponse, ) @app.get("/json") def j(): return {"key": "value"} # default → JSON @app.get("/html", response_class=HTMLResponse) def h(): return "

Hello

" # serve HTML @app.get("/text", response_class=PlainTextResponse) def t(): return "plain text" @app.get("/go") def g(): return RedirectResponse(url="/new-location") # 307 redirect ``` ## Servir archivos ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` sirve eficientemente un archivo desde disco (manejando encabezados, tipo de contenido) — para descargas, imágenes, documentos generados. ## Transmitir datos grandes o generados ```python @app.get("/stream") def stream(): def generate(): for i in range(1000000): yield f"line {i} " # yield chunks — NOT all loaded into memory return StreamingResponse(generate(), media_type="text/plain") ``` `StreamingResponse` envía datos incrementalmente desde un generador — esencial para datos **grandes o generados continuamente** (archivos grandes, exportaciones CSV, feeds en vivo) para que no cargues todo en memoria de una vez. (También la base de Server-Sent Events.) ## Codificadores JSON personalizados (JSON más rápido) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Por qué es importante Aunque JSON cubre la mayoría de las respuestas de API, las aplicaciones reales a menudo necesitan devolver otro contenido — y conocer los tipos de respuesta de FastAPI te permite manejarlos correctamente. **`FileResponse`** es necesaria para servir archivos y descargas (reportes, imágenes, documentos generados), **`StreamingResponse`** es importante para una entrega **eficiente en memoria** de datos grandes o generados continuamente (exportaciones grandes, transmisión de archivos, eventos enviados por el servidor — generando chunks en lugar de almacenar todo en memoria, lo que importa para la escalabilidad), y `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` manejan contenido no JSON y navegación. Comprender los tipos de respuesta disponibles y especialmente cuándo **transmitir** (para datos grandes, para evitar el agotamiento de memoria) versus devolver JSON es conocimiento práctico para construir APIs que van más allá de simples endpoints JSON — cubriendo descargas de archivos, exportaciones de datos y respuestas grandes o en tiempo real que son requisitos comunes en aplicaciones del mundo real.