რა ტიპის პასუხი შეგიძლიათ დააბრუნოთ JSON-ის გარდა?

Question

Accepted Answer

FastAPI სტანდარტულად აბრუნებს JSON-ს ( словарями, სიებსა და Pydantic მოდელების სერიალიზაცია), მაგრამ მხარს უჭერს მრავალ სხვა **პასუხის ტიპებს** სხვადსხვა საჭიროებებისთვის — HTML, ფაილები, ნაკადები, გადამისამართებები და ჩვეულებრივი ტექსტი — `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` ეფექტურად მოამარტოვებს ფაილს დისკიდან (თავსართი, კონტენტის ტიპი) — ჩამოტვირთვებისთვის, გამოსახულებებისთვის, გენერირებული დოკუმენტებისთვის. ## დიდი ან გენერირებული მონაცემების ნაკადი ```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) ისე რომ ყველაფერი ერთხელ მეხსიერებაში არ ჩატვირთოთ. (ასევე Server-Sent Events-ის საფუძველი.) ## მორგებული JSON კოდირებელი (უფრო სწრაფი JSON) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## რატომ არის ეს მნიშვნელოვანი JSON ფარავს უმეტეს API პასუხებს, მაგრამ რეალური აპლიკაციები ხშირად უნდა დააბრუნოს სხვა კონტენტი — და FastAPI-ს პასუხის ტიპების ცოდნა საშუალებას აძლევთ მათი სწორად მართვა. **`FileResponse`** საჭიროა ფაილებისა და ჩამოტვირთვების მომსახურებისთვის (ანგარიშები, გამოსახულებები, გენერირებული დოკუმენტები), **`StreamingResponse`** მნიშვნელოვანია **მეხსიერების ეფექტური** მიწოდებისთვის დიდი ან მუდმივად გენერირებული მონაცემებისთვის (დიდი ექსპორტი, ფაილის ნაკადი, server-sent events — თანმიმდევრობების გენერირება მეხსიერების სრულ დაკომპლექტებაზე, რაც მნიშვნელოვანია სკალაბილობისთვის), ხოლო `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` მართავენ არა-JSON კონტენტსა და ნავიგაციას. ელემენტარული პასუხის ტიპების გაგება და განსაკუთრებით როდის **ნაკადი** (დიდი მონაცემებისთვის, მეხსიერების ამოწურვის თავიდან ასაცილებლად) სხვა JSON-ის დაბრუნებაზე არის პრაქტიკული ცოდნა API-ების აგებისთვის, რომლებიც მიდის მხოლოდ JSON endpoint-ებთან — ფაილის ჩამოტვირთვა, მონაცემების ექსპორტი და დიდი ან real-time პასუხები, რომლებიც ჩვეულებრივი მოთხოვნაა რეალური აპლიკაციებში.