Параметри заголовків¶
Ви можете визначати параметри заголовків так само, як визначаєте параметри Query, Path і Cookie.
Імпорт Header¶
Спочатку імпортуйте Header:
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Annotated[str | None, Header()] = None):
return {"User-Agent": user_agent}
🤓 Other versions and variants
from typing import Annotated, Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Annotated[Union[str, None], Header()] = None):
return {"User-Agent": user_agent}
Tip
Prefer to use the Annotated version if possible.
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: str | None = Header(default=None)):
return {"User-Agent": user_agent}
Tip
Prefer to use the Annotated version if possible.
from typing import Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Union[str, None] = Header(default=None)):
return {"User-Agent": user_agent}
Оголошення параметрів Header¶
Потім оголосіть параметри заголовків, використовуючи ту ж структуру, що й для Path, Query та Cookie.
Ви можете визначити значення за замовчуванням, а також усі додаткові параметри валідації або анотації:
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Annotated[str | None, Header()] = None):
return {"User-Agent": user_agent}
🤓 Other versions and variants
from typing import Annotated, Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Annotated[Union[str, None], Header()] = None):
return {"User-Agent": user_agent}
Tip
Prefer to use the Annotated version if possible.
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: str | None = Header(default=None)):
return {"User-Agent": user_agent}
Tip
Prefer to use the Annotated version if possible.
from typing import Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Union[str, None] = Header(default=None)):
return {"User-Agent": user_agent}
Технічні деталі
Header є «сестринським» класом для Path, Query і Cookie. Він також успадковується від того ж спільного класу Param.
Але пам’ятайте, що коли ви імпортуєте Query, Path, Header та інші з fastapi, то насправді це функції, які повертають спеціальні класи.
Інформація
Щоб оголосити заголовки, потрібно використовувати Header, інакше параметри будуть інтерпретуватися як параметри запиту.
Автоматичне перетворення¶
Header має трохи додаткової функціональності порівняно з тим, що надають Path, Query та Cookie.
Більшість стандартних заголовків розділяються символом «дефіс», також відомим як «символ мінуса» (-).
Але змінна, така як user-agent, є недійсною в Python.
Тому, за замовчуванням, Header перетворюватиме символи підкреслення (_) у назвах параметрів на дефіси (-), щоб отримувати та документувати заголовки.
Також заголовки HTTP не чутливі до регістру, тож ви можете оголошувати їх у стандартному стилі Python (також відомому як «snake_case»).
Тому ви можете використовувати user_agent, як зазвичай у коді Python, замість того щоб потрібно було писати з великої літери перші літери, як User_Agent або щось подібне.
Якщо з якоїсь причини вам потрібно вимкнути автоматичне перетворення підкреслень на дефіси, встановіть параметр convert_underscores у Header в False:
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
strange_header: Annotated[str | None, Header(convert_underscores=False)] = None,
):
return {"strange_header": strange_header}
🤓 Other versions and variants
from typing import Annotated, Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
strange_header: Annotated[
Union[str, None], Header(convert_underscores=False)
] = None,
):
return {"strange_header": strange_header}
Tip
Prefer to use the Annotated version if possible.
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
strange_header: str | None = Header(default=None, convert_underscores=False),
):
return {"strange_header": strange_header}
Tip
Prefer to use the Annotated version if possible.
from typing import Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
strange_header: Union[str, None] = Header(default=None, convert_underscores=False),
):
return {"strange_header": strange_header}
Попередження
Перед тим як встановити convert_underscores в False, пам’ятайте, що деякі HTTP-проксі та сервери забороняють використання заголовків із підкресленнями.
Дубльовані заголовки¶
Можливо отримати дубльовані заголовки. Тобто один і той самий заголовок із кількома значеннями.
Ви можете визначити такі випадки, використовуючи список у типізації.
Ви отримаєте всі значення дубльованого заголовка у вигляді Python-list.
Наприклад, щоб оголосити заголовок X-Token, який може з’являтися більше ніж один раз, ви можете написати:
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(x_token: Annotated[list[str] | None, Header()] = None):
return {"X-Token values": x_token}
🤓 Other versions and variants
from typing import Annotated, Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(x_token: Annotated[Union[list[str], None], Header()] = None):
return {"X-Token values": x_token}
Tip
Prefer to use the Annotated version if possible.
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(x_token: list[str] | None = Header(default=None)):
return {"X-Token values": x_token}
Tip
Prefer to use the Annotated version if possible.
from typing import Union
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(x_token: Union[list[str], None] = Header(default=None)):
return {"X-Token values": x_token}
Якщо ви взаємодієте з цією операцією шляху, надсилаючи два HTTP-заголовки, наприклад:
X-Token: foo
X-Token: bar
Відповідь буде така:
{
"X-Token values": [
"bar",
"foo"
]
}
Підсумок¶
Оголошуйте заголовки за допомогою Header, використовуючи той самий загальний підхід, що й для Query, Path та Cookie.
І не хвилюйтеся про підкреслення у ваших змінних — FastAPI подбає про їх перетворення.