ما أنواع الاستجابات التي يمكنك إرجاعها بخلاف JSON؟

Question

Accepted Answer

يعيد FastAPI JSON افتراضياً (مع تسلسل dicts و lists و Pydantic models)، لكنه يدعم العديد من **أنواع الاستجابات** المختلفة للاحتياجات المختلفة — HTML وملفات وتدفقات وإعادات توجيه ونص عادي — عبر classes `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 والتغذيات المباشرة) بحيث لا تحمل كل شيء في الذاكرة في المرة الواحدة. (وأيضاً أساس 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`** مهمة لتسليم **فعال للذاكرة** من البيانات الكبيرة أو المولدة بشكل مستمر (الصادرات الكبيرة وتدفق الملفات والأحداث المرسلة من الخادم — إنتاج أجزاء بدلاً من تخزين كل شيء في الذاكرة مؤقتاً مما يهم للقابلية)، و `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` التعامل مع المحتوى غير JSON والملاحة. فهم أنواع الاستجابات المتاحة وخاصة متى **تدفق** (للبيانات الكبيرة لتجنب استنزاف الذاكرة) مقابل إرجاع JSON هو معرفة عملية لبناء APIs تتجاوز نقاط نهاية JSON البسيطة — تغطي تنزيلات الملفات وصادرات البيانات والاستجابات الكبيرة أو في الوقت الفعلي التي هي متطلبات شائعة في التطبيقات الحقيقية.