응답 헤더

Response 매개변수 사용하기

경로 연산 함수에서 Response 타입의 매개 변수를 지정할 수 있습니다. (응답 쿠키에서 처럼).

그런 다음 임시 응답 객체에 헤더를 설정할 수 있습니다.

from fastapi import FastAPI, Response

app = FastAPI()


@app.get("/headers-and-object/")
def get_headers(response: Response):
    response.headers["X-Cat-Dog"] = "alone in the world"
    return {"message": "Hello World"}

그런 다음 평소처럼 필요한 객체를 반환할 수 있습니다 (dict, 데이터베이스 모델, 기타 등등).

response_model를 선언했다면, 반환될 객체를 필터링, 변환하는데 여전히 사용될겁니다.

FastAPI는 임시 응답 객체를 이용해 헤더(그리고 쿠키, 응답 코드)를 추출하고, response_model로 필터링 된 최종 값들이 최종 응답에 포함될 것입니다.

또는 Response 매개변수를 종속성에서 선언하고, 거기에 헤더(그리고 쿠키)를 설정할 수도 있습니다.

Response 직접적으로 반환하기

Response를 직접적으로 반환할 때 헤더를 추가할 수도 있습니다.

응답 직접 반환하기에 설명된 것 처럼 응답을 만들어 추가적인 매개 변수와 함께 헤더를 넘기면 됩니다.

Create a response as described in Return a Response Directly and pass the headers as an additional parameter:

from fastapi import FastAPI
from fastapi.responses import JSONResponse

app = FastAPI()


@app.get("/headers/")
def get_headers():
    content = {"message": "Hello World"}
    headers = {"X-Cat-Dog": "alone in the world", "Content-Language": "en-US"}
    return JSONResponse(content=content, headers=headers)

기술적 세부사항

from starlette.responses import Response 혹은 from starlette.responses import JSONResponse를 사용하도 됩니다.

FastAPI는 starlette.responses를 개발자의 편리함을 위해 fastapi.responses로 이름을 바꿔 제공하고 있습니다. 대부분의 가능한 응답은 Starlette에서 직접 제공하고 있습니다.

그리고 Response는 헤더와 쿠키를 설정하는 데 자주 사용할 수 있으므로, FastAPI또한 이걸 fastapi.Response로 제공하고 있습니다.

커스텀 헤더

'X-' 접두사를 이용해 사용자 정의 독점 헤더를 추가할 수도 있음을 염두에 두십시오.

하지만 브라우저에서 클라이언트가 볼 수 있는 커스텀 헤더를 갖게 할려면 CORS 설정에서 이를 추가해야 됩니다. (CORS (Cross-Origin Resource Sharing)에서 자세히 읽어보세요.) Starlette's CORS docs에서 설명된 expose_headers를 사용하세요.