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 को incrementally भेजता है — **बड़े या निरंतर-generated** data (बड़ी files, CSV exports, live feeds) के लिए आवश्यक ताकि आप इसे एक साथ memory में load न करें। (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 को कवर करता है, वास्तविक applications को अक्सर अन्य content लौटाने की आवश्यकता होती है — और FastAPI के response types को जानना आपको इन्हें सही ढंग से संभालने देता है। **`FileResponse`** files और downloads (reports, images, generated documents) को serve करने के लिए आवश्यक है, **`StreamingResponse`** बड़े या निरंतर-generated data की **memory-efficient** delivery के लिए महत्वपूर्ण है (बड़े exports, file streaming, server-sent events — सब कुछ memory में buffer करने के बजाय chunks yield करना, जो scalability के लिए मायने रखता है), और `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` non-JSON content और navigation को संभालते हैं। उपलब्ध response types को समझना और विशेष रूप से कब **stream** करें (बड़े data के लिए, memory exhaustion से बचने के लिए) बनाम JSON लौटाएं, साधारण JSON endpoints से परे जाने वाली APIs बनाने के लिए व्यावहारिक ज्ञान है — file downloads, data exports, और बड़े या real-time responses को कवर करते हुए जो वास्तविक applications में सामान्य आवश्यकताएं हैं।