JSON కంటే ఎక్కువ రెస్‌పాన్స్ రకాలను మీరు ఏవి రిటర్న్ చేయవచ్చు?

Question

Accepted Answer

FastAPI డిఫాల్ట్‌గా JSON ను రిటర్న్ చేస్తుంది (dicts, lists, మరియు Pydantic models లను సీరియలైజ్ చేస్తుంది), కానీ ఇది వివిధ అవసరాల కోసం చాలా ఇతర **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 ``` ## ఫైల్‌లను సేవ చేయడం ```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` జెనరేటర్ నుండి డేటా క్రమంగా పంపుతుంది — **పెద్ద లేదా నిరంతరం-రూపొందించిన** డేటా (పెద్ద ఫైల్‌లు, CSV ఎక్స్‌పోర్ట్‌లు, live feeds) కోసం ఇది ముఖ్యమైనది కాబట్టి మీరు దానిని ఒకేసారి మెమరీలో లోడ్ చేయవలసిన అవసరం లేదు. (సర్వర్-సెంట్ ఎవెంట్‌ల ఆధారం కూడా.) ## కస్టమ్ JSON encoders (faster 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`** ఫైల్‌లు మరియు డౌన్‌లోడ్‌లను సేవ చేయడానికి అవసరం (reports, images, రూపొందించిన డాక్యుమెంట్‌లు), **`StreamingResponse`** పెద్ద లేదా నిరంతరం-రూపొందించిన డేటా (**memory-efficient** డెలివరీ కోసం) ముఖ్యమైనది (పెద్ద ఎక్స్‌పోర్ట్‌లు, ఫైల్ స్ట్రీమింగ్, server-sent events — chunks ను yielding చేయడం ద్వారా ఎందుకంటే మెమరీ ఖాళీయీకరణ అనేది scalability కోసం ముఖ్యమైనది), మరియు `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` non-JSON కంటెంట్ మరియు నావిగేషన్ నిర్వహిస్తాయి. లభ్యమైన response types మరియు ప్రత్యేకించి ఎప్పుడు **stream** చేయాలో (పెద్ద డేటా కోసం, మెమరీ ఖాళీయీకరణను నివారించడానికి) సాధారణ JSON endpoints కంటే ఎక్కువ అనే ఆచరణాత్మక జ్ఞానం — ఫైల్ డౌన్‌లోడ్‌లు, డేటా ఎక్స్‌పోర్ట్‌లు, మరియు పెద్ద లేదా real-time ప్రతిస్పందనలను కవర్ చేయడం ఇది నిజమైన-ప్రపంచ అప్లికేషన్‌లలో సాధారణ అవసరాలు.