Атрибут headers

Атрибут headers применяется к объекту ответа Response и представляет собой словарь с HTTP-заголовками. Через него можно читать установленные заголовки и добавлять собственные перед отправкой ответа. Значением выступает обычный словарь Python, где ключ - имя заголовка, а значение - его содержимое.

Синтаксис

response.headers

Обращение к атрибуту возвращает словарь заголовков. Присваивание нового значения заменяет весь набор заголовков.

Пример

Давайте установим собственный заголовок через объект ответа:

from fastapi import FastAPI, Response

app = FastAPI()

@app.get('/')
def index(response: Response):
	response.headers['X-Custom-Header'] = 'abcde'
	return {'text': 'hello'}

В ответе клиент получит заголовок X-Custom-Header: abcde.

Пример

Давайте прочитаем уже установленные заголовки и добавим новый на их основе:

<+python+> from fastapi import FastAPI, Response app = FastAPI() @app.get('/') def index(response: Response): content_type = response.headers.get('content-type') response.headers['X-Content-Type'] = str(content_type) return {'text': 'hello'} <-python+>

Результат выполнения кода для заголовка content-type:

"application/json"

Пример

Давайте создадим объект ответа вручную и зададим заголовки прямо в конструкторе:

<+python+> from fastapi import FastAPI from fastapi.responses import JSONResponse app = FastAPI() @app.get('/') def index(): headers = {'X-Article': 'abcde'} return JSONResponse( content={'text': 'hello'}, headers=headers ) <-python+>

Результат выполнения кода:

{"text": "hello"}

Смотрите также

класс Response,
который представляет собой HTTP-ответ целиком
атрибут status_code,
который хранит код состояния ответа
атрибут media_type,
который задаёт тип содержимого ответа
класс JSONResponse,
который формирует JSON-ответ с заголовками