Quali tipi di risposta puoi restituire oltre a JSON?

Question

Accepted Answer

FastAPI restituisce JSON per impostazione predefinita (serializzando dizionari, liste e modelli Pydantic), ma supporta molti altri **tipi di risposta** per esigenze diverse — HTML, file, stream, redirect e testo semplice — tramite le classi `fastapi.responses`. ## Le classi di risposta predefinite e comuni ```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 ``` ## Servire file ```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 in modo efficiente un file dal disco (gestendo intestazioni e tipo di contenuto) — per download, immagini, documenti generati. ## Streaming di dati grandi o generati ```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` invia dati in modo incrementale da un generatore — essenziale per dati **grandi o continuamente generati** (file voluminosi, esportazioni CSV, feed live) in modo da non caricarli completamente in memoria. (È anche la base dei Server-Sent Events.) ## Codificatori JSON personalizzati (JSON più veloce) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Perché è importante Sebbene JSON copra la maggior parte delle risposte API, le applicazioni reali spesso devono restituire altri contenuti — e conoscere i tipi di risposta di FastAPI ti permette di gestirli correttamente. **`FileResponse`** è necessaria per servire file e download (report, immagini, documenti generati), **`StreamingResponse`** è importante per la consegna **memory-efficient** di dati grandi o continuamente generati (grandi esportazioni, streaming di file, server-sent events — cedendo chunk invece di bufferizzare tutto in memoria, che conta per la scalabilità), e `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` gestiscono contenuti non-JSON e navigazione. Comprendere i tipi di risposta disponibili e soprattutto quando fare **streaming** (per dati grandi, per evitare l'esaurimento della memoria) rispetto a restituire JSON è una conoscenza pratica per costruire API che vanno oltre semplici endpoint JSON — coprendo download di file, esportazioni di dati e risposte grandi o in tempo reale che sono requisiti comuni nelle applicazioni reali.