除了 JSON，您还可以返回哪些响应类型？

Question

Accepted Answer

FastAPI 默认返回 JSON（序列化 dicts、lists 和 Pydantic 模型），但它通过 `fastapi.responses` 类支持许多其他**响应类型**以满足不同的需求 — HTML、文件、流、重定向和纯文本。 ## 默认和常见响应类 ```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 导出、实时源）至关重要，这样您就不会一次性将其全部加载到内存中。（也是 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 是实用知识，用于构建超越简单 JSON 端点的 API — 涵盖文件下载、数据导出以及大型或实时响应，这些是真实应用程序中的常见需求。