JSON 외에 어떤 응답 타입을 반환할 수 있습니까?

Question

Accepted Answer

FastAPI는 기본적으로 JSON을 반환하지만(dict, list, Pydantic 모델 직렬화), `fastapi.responses` 클래스를 통해 다양한 다른 **응답 타입**—HTML, 파일, 스트림, 리다이렉트, 일반 텍스트—을 다양한 필요에 맞게 지원합니다. ## 기본 및 일반적인 응답 클래스 ```python from fastapi.responses import ( JSONResponse, HTMLResponse, PlainTextResponse, RedirectResponse, FileResponse, StreamingResponse, ) @app.get("/json") def j(): return {"key": "value"} # 기본 → JSON @app.get("/html", response_class=HTMLResponse) def h(): return "

Hello

" # HTML 제공 @app.get("/text", response_class=PlainTextResponse) def t(): return "plain text" @app.get("/go") def g(): return RedirectResponse(url="/new-location") # 307 리다이렉트 ``` ## 파일 제공 ```python @app.get("/download") def download(): return FileResponse( "report.pdf", media_type="application/pdf", filename="report.pdf", # 이 이름으로 다운로드를 유도 ) ``` `FileResponse`는 디스크의 파일을 효율적으로 제공합니다(헤더, 콘텐츠 타입 처리) — 다운로드, 이미지, 생성된 문서용. ## 크거나 생성되는 데이터 스트리밍 ```python @app.get("/stream") def stream(): def generate(): for i in range(1000000): yield f"line {i} " # 청크를 yield — 전부 메모리에 로드하지 않음 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) # 더 빠른 JSON 직렬화를 위해 orjson 사용 ``` ## 왜 중요한가 JSON이 대부분의 API 응답을 다루지만, 실제 애플리케이션은 흔히 다른 콘텐츠를 반환해야 합니다. FastAPI의 응답 타입을 아는 것은 이를 올바르게 처리하게 합니다. **`FileResponse`**는 파일과 다운로드(리포트, 이미지, 생성된 문서) 제공에 필요하고, **`StreamingResponse`**는 크거나 연속적으로 생성되는 데이터의 **메모리 효율적** 전달(큰 내보내기, 파일 스트리밍, server-sent events — 모든 것을 메모리에 버퍼링하는 대신 청크를 yield, 확장성에 중요)에 중요하며, `HTMLResponse`/`PlainTextResponse`/`RedirectResponse`는 비JSON 콘텐츠와 내비게이션을 처리합니다. 사용 가능한 응답 타입과, 특히 언제 **스트리밍**해야 하는지(큰 데이터, 메모리 소진 방지)와 JSON을 반환할지를 이해하는 것은 단순 JSON 엔드포인트를 넘어서는 API를 구축하기 위한 실용 지식입니다. 실제 애플리케이션에서 흔한 요구사항인 파일 다운로드, 데이터 내보내기, 크거나 실시간인 응답을 다룹니다.