HTTP-заголовки ответа¶
Использовать параметр Response¶
Вы можете объявить параметр типа Response в вашей функции-обработчике пути (как можно сделать и для cookie).
А затем вы можете устанавливать HTTP-заголовки в этом временном объекте ответа.
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 использует этот временный ответ, чтобы извлечь HTTP-заголовки (а также cookie и статус-код) и поместит их в финальный HTTP-ответ, который содержит возвращённое вами значение, отфильтрованное согласно response_model.
Вы также можете объявлять параметр Response в зависимостях и устанавливать в них заголовки (и cookie).
Вернуть Response напрямую¶
Вы также можете добавить HTTP-заголовки, когда возвращаете Response напрямую.
Создайте ответ, как описано в Вернуть Response напрямую, и передайте заголовки как дополнительный параметр:
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 часто используется для установки заголовков и cookie, FastAPI также предоставляет его как fastapi.Response.
Пользовательские HTTP-заголовки¶
Помните, что собственные проприетарные заголовки можно добавлять, используя префикс X-.
Но если у вас есть пользовательские заголовки, которые вы хотите показывать клиенту в браузере, вам нужно добавить их в настройки CORS (подробнее см. в CORS (Cross-Origin Resource Sharing)), используя параметр expose_headers, описанный в документации Starlette по CORS.