Ni aina gani za response unaweza kurudisha zaidi ya JSON?

Question

Accepted Answer

FastAPI hurudisha JSON kwa chaguo-msingi (ikiserialize dicts, lists, na miundo ya Pydantic), lakini inasaidia **aina za response** nyingine nyingi kwa mahitaji tofauti — HTML, files, streams, redirects, na maandishi tambarare — kupitia classes za `fastapi.responses`. ## Response classes za chaguo-msingi na za kawaida ```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 ``` ## Kutoa files ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` hutoa file kutoka diski kwa ufanisi (ikishughulikia headers, content type) — kwa downloads, picha, hati zilizozalishwa. ## Streaming ya data kubwa au iliyozalishwa ```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` hutuma data kwa nyongeza kutoka kwa generator — muhimu kwa data **kubwa au inayozalishwa kwa kuendelea** (files kubwa, CSV exports, live feeds) ili usiipakie yote katika kumbukumbu kwa wakati mmoja. (Pia ni msingi wa Server-Sent Events.) ## JSON encoders maalum (JSON ya haraka zaidi) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## Kwa nini ni muhimu Ingawa JSON inashughulikia response nyingi za API, programu halisi mara nyingi zinahitaji kurudisha maudhui mengine — na kujua aina za response za FastAPI kunakuwezesha kushughulikia haya kwa usahihi. **`FileResponse`** inahitajika kwa kutoa files na downloads (ripoti, picha, hati zilizozalishwa), **`StreamingResponse`** ni muhimu kwa utoaji **wenye ufanisi wa kumbukumbu** wa data kubwa au inayozalishwa kwa kuendelea (exports kubwa, file streaming, server-sent events — kutoa chunks badala ya kuhifadhi kila kitu katika kumbukumbu, jambo linalohusika na uwezo wa kupanuka), na `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` hushughulikia maudhui yasiyo ya JSON na urambazaji. Kuelewa aina za response zinazopatikana na hasa wakati wa **kufanya stream** (kwa data kubwa, ili kuepuka uchovu wa kumbukumbu) dhidi ya kurudisha JSON ni maarifa ya vitendo kwa kujenga API zinazokwenda zaidi ya endpoints rahisi za JSON — zikishughulikia file downloads, data exports, na response kubwa au za wakati halisi ambazo ni mahitaji ya kawaida katika programu za ulimwengu halisi.