Какие типы ответов вы можете возвращать помимо JSON?

Question

Accepted Answer

FastAPI по умолчанию возвращает JSON (сериализуя dicts, lists и модели Pydantic), но поддерживает много других **response types** для разных потребностей — 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` эффективно подаёт файл с диска (обрабатывая 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` отправляет данные пошагово из generator — необходима для **больших или постоянно генерируемых** данных (большие файлы, 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 ответов, реальные приложения часто должны возвращать другой контент — и знание response types FastAPI позволяет вам обрабатывать их правильно. **`FileResponse`** необходим для подачи файлов и загрузок (отчёты, изображения, сгенерированные документы), **`StreamingResponse`** важна для **экономной по памяти** доставки больших или постоянно генерируемых данных (большие экспорты, потоковая передача файлов, server-sent events — возвращение частей вместо буферизации всего в памяти, что имеет значение для масштабируемости), а `HTMLResponse`/`PlainTextResponse`/`RedirectResponse` обрабатывают не-JSON контент и навигацию. Понимание доступных response types и особенно когда **передавать потоком** (для больших данных, чтобы избежать истощения памяти) в сравнении с возвратом JSON — это практическое знание для создания API, выходящих за рамки простых JSON endpoints — охватывающих загрузки файлов, экспорты данных и большие или real-time ответы, которые являются распространёнными требованиями в реальных приложениях.