آپ JSON کے علاوہ کون سی response types واپس کر سکتے ہیں؟

Question

Accepted Answer

FastAPI بطور ڈیفالٹ JSON واپس کرتا ہے (dicts، lists، اور Pydantic models کو serialize کرتے ہوئے)، لیکن یہ مختلف ضروریات کے لیے بہت سی دوسری **response types** کو سپورٹ کرتا ہے — HTML، files، streams، redirects، اور plain text — `fastapi.responses` classes کے ذریعے۔ ## ڈیفالٹ اور عام response classes ```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 ``` ## Files کو serve کرنا ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # prompts a download with this name ) ``` `FileResponse` disk سے ایک file کو موثر طریقے سے serve کرتا ہے (headers، content type کو سنبھالتے ہوئے) — downloads، images، generated documents کے لیے۔ ## بڑے یا generated data کو stream کرنا ```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 سے data کو بتدریج بھیجتا ہے — **بڑے یا مسلسل-generated** data (بڑی files، CSV exports، live feeds) کے لیے ضروری ہے تاکہ آپ اسے پوری طرح میموری میں لوڈ نہ کریں۔ (یہ Server-Sent Events کی بنیاد بھی ہے۔) ## Custom JSON encoders (تیز JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## یہ کیوں اہم ہے اگرچہ JSON زیادہ تر API responses کو cover کرتا ہے، حقیقی applications اکثر دوسری content واپس کرنے کی ضرورت رکھتی ہیں — اور FastAPI کی response types کو جاننے سے آپ ان کو صحیح طریقے سے handle کر سکتے ہیں۔ **`FileResponse`** files اور downloads (reports، images، generated documents) کو serve کرنے کے لیے ضروری ہے، **`StreamingResponse`** بڑے یا مسلسل-generated data (بڑے exports، file streaming، server-sent events — chunks کو yield کرتے ہوئے بجائے ہر چیز کو میموری میں buffer کرنے کے، جو scalability کے لیے اہم ہے) کی **memory-efficient** delivery کے لیے اہم ہے، اور `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` غیر-JSON content اور navigation کو handle کرتے ہیں۔ دستیاب response types کو سمجھنا اور خاص طور پر کب **stream** کریں (بڑے data کے لیے، memory exhaustion سے بچنے کے لیے) بمقابلہ JSON واپس کریں یہ عملی علم ہے simple JSON endpoints سے آگے APIs بنانے کے لیے — file downloads، data exports، اور بڑے یا real-time responses کو cover کرتے ہوئے جو حقیقی-دنیا کی applications میں عام requirements ہیں۔