Liema tipi ta' risposta tista' tirritorna barra minn JSON?

Question

Accepted Answer

FastAPI jirritorna JSON b'mod default (serializzando dicts, lists, u mudelli Pydantic), imma tsuppurta ħafna oħrajn **tipi ta' risposta** għal bżonnijiet differenti — HTML, fajls, streams, rdirezzjonamenti, u test sempliċi — permezz tal-klassiet `fastapi.responses`. ## Il-klassiet ta' risposta default u komuni ```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 ``` ## Is-servizz tal-fajls ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` iservi fajl mid-disk b'mod effiċjenti (tittratta headers, tip ta' kontenut) — għal downloads, immaġini, dokumenti ġenerati. ## Streaming ta' data kbira jew ġenerata ```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` tibgħat data b'mod inkrementali minn ġenerator — essenzjali għal data **kbira jew kontinwu ġenerata** (fajls kbari, esportazzjonijiet CSV, live feeds) sabiex ma tilload kollox fil-memorja f'darba. (Wkoll il-bażi tal-Server-Sent Events.) ## Kodifikatur JSON personalizat (JSON aktar malajr) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Għalfejn hawn l-importanza Jenħ JSON jikopri l-biċċa l-kbira tar-risposti API, l-applikazzjonijiet reali ħaftas irridu jirritornaw kontenut ieħor — u li naf it-tipi ta' risposta ta' FastAPI jippermettilk tittratta dawn b'mod korrett. **`FileResponse`** hija meħtieġa biex is-servi tal-fajls u downloads (rapporti, immaġini, dokumenti ġenerati), **`StreamingResponse`** hija importanti għall-konsenja **effiċjenti tal-memorja** ta' data kbira jew kontinwu ġenerata (esportazzjonijiet kbari, streaming tal-fajl, server-sent events — jipproduċu chunks minflok li jibaffraw kollox fil-memorja, li huwa importanti għas-skalabbilità), u `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` itrattaw kontenut mhux JSON u navigazzjoni. L-ipprimi tal-proprjetà ta' tipi ta' risposta disponibbli u speċjalment meta **stream** (għal data kbira, biex tevita l-exhaustion tal-memorja) kontra l-irtorn ta' JSON hija għarfien prattiċi għall-bini ta' APIs li għad jmorru lil hinn minn endpoints JSON sempliċi — li jkopru downloads tal-fajls, esportazzjonijiet ta' data, u risposti kbari jew real-time li huma rekwiżiti komuni fl-applikazzjonijiet tal-ħajja reali.