คุณสามารถ return response type อะไรได้บ้างนอกเหนือจาก JSON?

Question

Accepted Answer

FastAPI return JSON เป็นค่าเริ่มต้น (โดย serialize dict, list และ Pydantic model) แต่มันรองรับ **response type** อื่น ๆ อีกมากสำหรับความต้องการที่แตกต่างกัน — HTML, ไฟล์, stream, redirect และ plain text — ผ่าน class ใน `fastapi.responses` ## response class แบบเริ่มต้นและที่ใช้บ่อย ```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 ``` ## การ 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` serve ไฟล์จากดิสก์ได้อย่างมีประสิทธิภาพ (จัดการ header, content type) — สำหรับการดาวน์โหลด, รูปภาพ, เอกสารที่สร้างขึ้น ## การ 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 — จำเป็นสำหรับข้อมูล **ขนาดใหญ่หรือที่สร้างขึ้นอย่างต่อเนื่อง** (ไฟล์ขนาดใหญ่, การ export CSV, live feed) เพื่อที่คุณจะไม่ต้องโหลดทั้งหมดเข้า memory ในคราวเดียว (และยังเป็นพื้นฐานของ Server-Sent Events ด้วย) ## Custom JSON encoder (JSON ที่เร็วกว่า) ```python from fastapi.responses import ORJSONResponse app = FastAPI(default_response_class=ORJSONResponse) # use orjson for faster JSON serialization ``` ## ทำไมจึงสำคัญ แม้ว่า JSON จะครอบคลุม API response ส่วนใหญ่ แต่แอปพลิเคชันจริงมักต้อง return content แบบอื่น — และการรู้ response type ของ FastAPI ช่วยให้คุณจัดการสิ่งเหล่านี้ได้อย่างถูกต้อง **`FileResponse`** จำเป็นสำหรับการ serve ไฟล์และการดาวน์โหลด (รายงาน, รูปภาพ, เอกสารที่สร้างขึ้น), **`StreamingResponse`** สำคัญสำหรับการส่งมอบข้อมูลขนาดใหญ่หรือที่สร้างขึ้นอย่างต่อเนื่องแบบ **ประหยัด memory** (การ export ขนาดใหญ่, การ stream ไฟล์, server-sent event — โดย yield ทีละส่วนแทนการ buffer ทั้งหมดใน memory ซึ่งสำคัญต่อความสามารถในการ scale) และ `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` จัดการ content ที่ไม่ใช่ JSON และการนำทาง การเข้าใจ response type ที่มีให้ และโดยเฉพาะอย่างยิ่งว่าเมื่อใดควร **stream** (สำหรับข้อมูลขนาดใหญ่ เพื่อหลีกเลี่ยง memory หมด) เทียบกับการ return JSON เป็นความรู้เชิงปฏิบัติสำหรับการสร้าง API ที่ก้าวข้าม endpoint แบบ JSON ธรรมดา — ครอบคลุมการดาวน์โหลดไฟล์, การ export ข้อมูล และ response ขนาดใหญ่หรือแบบ real-time ที่เป็นความต้องการทั่วไปในแอปพลิเคชันโลกจริง