Que tipos de resposta você pode retornar além de JSON?

Question

Accepted Answer

FastAPI retorna JSON por padrão (serializando dicts, listas e modelos Pydantic), mas suporta muitos outros **response types** para diferentes necessidades — HTML, arquivos, fluxos, redirecionamentos e texto simples — através das classes `fastapi.responses`. ## As classes de resposta padrão e comuns ```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 ``` ## Servindo arquivos ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` serve um arquivo do disco de forma eficiente (tratando headers, tipo de conteúdo) — para downloads, imagens, documentos gerados. ## Transmitindo dados grandes ou gerados ```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` envia dados incrementalmente de um gerador — essencial para **dados grandes ou continuamente gerados** (arquivos grandes, exportações CSV, feeds ao vivo) para que você não carregue tudo na memória de uma vez. (Também a base de Server-Sent Events.) ## Codificadores JSON personalizados (JSON mais rápido) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Por que isso importa Embora JSON cubra a maioria das respostas de API, aplicações reais frequentemente precisam retornar outro conteúdo — e conhecer os response types do FastAPI permite lidar com eles corretamente. **`FileResponse`** é necessário para servir arquivos e downloads (relatórios, imagens, documentos gerados), **`StreamingResponse`** é importante para entrega **eficiente em memória** de dados grandes ou continuamente gerados (grandes exportações, streaming de arquivos, server-sent events — retornando pedaços em vez de armazenar tudo na memória, o que importa para escalabilidade), e `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` tratam conteúdo não-JSON e navegação. Compreender os response types disponíveis e especialmente quando **transmitir** (para dados grandes, para evitar esgotamento de memória) versus retornar JSON é conhecimento prático para construir APIs que vão além de simples endpoints JSON — cobrindo downloads de arquivos, exportações de dados e respostas grandes ou em tempo real que são requisitos comuns em aplicações do mundo real.