JSON ਤੋਂ ਇਲਾਵਾ ਤੁਸੀਂ ਕਿਹੜੀਆਂ ਪ੍ਰਤੀਕ੍ਰਿਆ ਕਿਸਮਾਂ ਵਾਪਸ ਕਰ ਸਕਦੇ ਹੋ?

Question

Accepted Answer

FastAPI ਪੂਰਵ-ਨਿਰਧਾਰਿਤ ਤੌਰ ਤੇ JSON ਵਾਪਸ ਕਰਦਾ ਹੈ (dicts, lists, ਅਤੇ Pydantic ਮਾਡਲਾਂ ਨੂੰ serialize ਕਰਦੇ ਹੋਏ), ਪਰ ਇਹ ਵੱਖ-ਵੱਖ ਜਰੂਰਤਾਂ ਲਈ ਬਹੁਤ ਸਾਰੀਆਂ ਹੋਰ **response types** ਦਾ ਸਮਰਥਨ ਕਰਦਾ ਹੈ — HTML, files, streams, redirects, ਅਤੇ plain text — `fastapi.responses` ਕਲਾਸਾਂ ਦੁਆਰਾ। ## ਡਿਫਾਲਟ ਅਤੇ ਆਮ ਪ੍ਰਤੀਕ੍ਰਿਆ ਕਲਾਸਾਂ ```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 ``` ## ਫਾਈਲਾਂ ਦੀ ਸੇਵਾ ਕਰਨਾ ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` ਡਿਸਕ ਤੋਂ ਪ੍ਰਭਾਵਸ਼ਾਲੀ ਢੰਗ ਨਾਲ ਇੱਕ ਫਾਈਲ ਦੀ ਸੇਵਾ ਕਰਦਾ ਹੈ (headers, content type ਨੂੰ ਸੰਭਾਲਦੇ ਹੋਏ) — ਡਾਊਨਲੋਡ, ਚਿੱਤਰ, ਉਤਪੰਨ ਦਸਤਾਵੇਜ਼ਾਂ ਲਈ। ## ਵੱਡਾ ਜਾਂ ਉਤਪੰਨ ਡੇਟਾ ਸਟ੍ਰੀਮ ਕਰਨਾ ```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` ਇੱਕ generator ਤੋਂ ਡੇਟਾ ਵਧਮਾਨ ਭੇਜਦਾ ਹੈ — **ਵੱਡੇ ਜਾਂ ਲਗਾਤਾਰ-ਉਤਪੰਨ** ਡੇਟਾ ਲਈ ਜ਼ਰੂਰੀ ਹੈ (ਵੱਡੀਆਂ ਫਾਈਲਾਂ, CSV exports, live feeds) ਤਾਂ ਜੋ ਤੁਸੀਂ ਇਸਨੂੰ ਇੱਕ ਵਾਰ ਵਿੱਚ ਮੈਮੋਰੀ ਵਿੱਚ ਲੋਡ ਨਾ ਕਰੋ। (ਇਹ ਵੀ Server-Sent Events ਦੀ ਬੁਨਿਆਦ ਹੈ।) ## ਕਸਟਮ JSON encoders (ਤੇਜ਼ JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## ਇਹ ਕਿਉਂ ਮਹੱਤਵਪੂਰਨ ਹੈ ਜਦੋਂ JSON ਜ਼ਿਆਦਾਤਰ API ਪ੍ਰਤੀਕ੍ਰਿਆਵਾਂ ਨੂੰ ਕਵਰ ਕਰਦਾ ਹੈ, ਅਸਲ ਮਾਤਰਾ ਵਿੱਚ ਅਕਸਰ ਹੋਰ ਸਮੱਗਰੀ ਵਾਪਸ ਕਰਨੀ ਪਵੇ — ਅਤੇ FastAPI ਦੀਆਂ response types ਨੂੰ ਜਾਣਨਾ ਤੁਹਾਨੂੰ ਇਨ੍ਹਾਂ ਨੂੰ ਸਹੀ ਢੰਗ ਨਾਲ ਸਭਾਲਣ ਦੇ ਸਕਦਾ ਹੈ। **`FileResponse`** ਫਾਈਲਾਂ ਅਤੇ ਡਾਊਨਲੋਡ ਦੀ ਸੇਵਾ ਕਰਨ ਲਈ ਜ਼ਰੂਰੀ ਹੈ (ਰਿਪੋਰਟਾਂ, ਚਿੱਤਰ, ਉਤਪੰਨ ਦਸਤਾਵੇਜ਼), **`StreamingResponse`** ਵੱਡੇ ਜਾਂ ਲਗਾਤਾਰ-ਉਤਪੰਨ ਡੇਟਾ (ਵੱਡੇ exports, file streaming, server-sent events — chunks ਦਾ ਇੱਕ ਫਲ) ਦੀ **ਮੈਮੋਰੀ-ਆਧਾਰਿਤ** ਡਿਲੀਵਰੀ ਲਈ ਮਹੱਤਵਪੂਰਨ ਹੈ, ਜੋ scalability ਲਈ ਮਹੱਤਵਪੂਰਨ ਹੈ, ਅਤੇ `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` ਗੈਰ-JSON ਸਮੱਗਰੀ ਅਤੇ navigation ਨੂੰ ਸੰਭਾਲਦੇ ਹਨ। ਉਪਲਬਧ response types ਨੂੰ ਸਮਝਣਾ ਅਤੇ ਖ਼ਾਸ ਤੌਰ ਤੇ ਕਦੋਂ **stream** ਕਰਨਾ ਹੈ (ਵੱਡੇ ਡੇਟਾ ਲਈ, ਮੈਮੋਰੀ exhaustion ਨੂੰ ਤੋੜਨ ਲਈ) ਬਨਾਮ JSON ਵਾਪਸ ਕਰਨਾ ਸਧਾਰਣ JSON endpoints ਤੋਂ ਪਰੇ ਜਾਣ ਵਾਲੇ APIs ਬਣਾਉਣ ਲਈ ਵਿਹਾਰਕ ਗਿਆਨ ਹੈ — file downloads, data exports, ਅਤੇ ਵੱਡੀਆਂ ਜਾਂ real-time ਪ੍ਰਤੀਕ੍ਰਿਆਵਾਂ ਨੂੰ ਕਵਰ ਕਰਦੇ ਹੋਏ ਜੋ ਵਾਸਤਵਿਕ ਦੁਨੀਆਂ ਐਪਲੀਕੇਸ਼ਨਾਂ ਵਿੱਚ ਆਮ ਜ਼ਰੂਰਤਾਂ ਹਨ।