FastAPI リクエストヘッダーとCookie
FastAPI は提供しますHeaderとCookie型を使用して、HTTPリクエストヘッダーとCookieからデータを取得します。
リクエストヘッダーパラメータ
使用Headerリクエストヘッダーパラメータを宣言します:
例
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
# User-Agent リクエストヘッダーを受け取る
user_agent: Annotated[str | None, Header()] = None,
):
return {"User-Agent": user_agent}
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
# User-Agent リクエストヘッダーを受け取る
user_agent: Annotated[str | None, Header()] = None,
):
return {"User-Agent": user_agent}
アクセスhttp://127.0.0.1:8000/items/すると、返されたJSONにブラウザのUser-Agent情報が含まれます。
リクエストヘッダーの自動変換
HTTPリクエストヘッダーのフィールド名はハイフンを使用します(例:X-Token)、Pythonの変数名にはハイフンを含めることができません。FastAPIが自動的に変換します:
例
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
# Pythonの変数名はアンダースコアを使用し、FastAPIがX-Tokenリクエストヘッダーに自動変換します
x_token: Annotated[list[str] | None, Header()] = None,
):
return {"X-Token values": x_token}
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
# Pythonの変数名はアンダースコアを使用し、FastAPIがX-Tokenリクエストヘッダーに自動変換します
x_token: Annotated[list[str] | None, Header()] = None,
):
return {"X-Token values": x_token}
変換ルール:
| Python変数名 | HTTPリクエストヘッダー | 説明 |
|---|---|---|
x_token | X-Token | アンダースコアは自動的にハイフンに変換されます |
user_agent | User-Agent | 同上 |
content_type | Content-Type | 同上 |
FastAPIは変数名のアンダースコアを自動的に
_ハイフンに変換します-リクエストヘッダーに一致させます。この変換を無効にする必要がある場合は、設定しますHeader(convert_underscores=False)。
重複するリクエストヘッダーの受け取り
一部のリクエストヘッダーは複数回出現する場合があります(例:Set-Cookie)、list型を使用して受け取ります:
例
from typing import Annotated
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
# 複数のX-Tokenリクエストヘッダーを受け取る
x_token: Annotated[list[str] | None, Header()] = None,
):
return {"X-Token values": x_token}
from fastapi import FastAPI, Header
app = FastAPI()
@app.get("/items/")
async def read_items(
# 複数のX-Tokenリクエストヘッダーを受け取る
x_token: Annotated[list[str] | None, Header()] = None,
):
return {"X-Token values": x_token}
リクエスト例:
GET /items/ HTTP/1.1 X-Token: foo X-Token: bar
レスポンス:{"X-Token values": ["foo", "bar"]}
Cookieパラメータ
使用CookieCookieパラメータを宣言します:
例
from typing import Annotated
from fastapi import FastAPI, Cookie
app = FastAPI()
@app.get("/items/")
async def read_items(
# session_token という名前のCookieを受け取る
session_token: Annotated[str | None, Cookie()] = None,
):
return {"session_token": session_token}
from fastapi import FastAPI, Cookie
app = FastAPI()
@app.get("/items/")
async def read_items(
# session_token という名前のCookieを受け取る
session_token: Annotated[str | None, Cookie()] = None,
):
return {"session_token": session_token}
リクエストヘッダーとCookieの同時使用
同じルート内でリクエストヘッダーとCookieを同時に取得できます:
例
from typing import Annotated
from fastapi import FastAPI, Header, Cookie
app = FastAPI()
@app.get("/items/")
async def read_items(
user_agent: Annotated[str | None, Header()] = None,
session_token: Annotated[str | None, Cookie()] = None,
ads_id: Annotated[str | None, Cookie()] = None,
):
return {
"User-Agent": user_agent,
"Session-Token": session_token,
"Ads-ID": ads_id,
}
from fastapi import FastAPI, Header, Cookie
app = FastAPI()
@app.get("/items/")
async def read_items(
user_agent: Annotated[str | None, Header()] = None,
session_token: Annotated[str | None, Cookie()] = None,
ads_id: Annotated[str | None, Cookie()] = None,
):
return {
"User-Agent": user_agent,
"Session-Token": session_token,
"Ads-ID": ads_id,
}

まとめ
- 使用
HeaderHTTPリクエストヘッダーパラメータを取得します - 使用
CookieCookieパラメータを取得します - FastAPIはPython変数名のアンダースコアをリクエストヘッダーのハイフンに自動変換します
- 使用
list[str]重複するリクエストヘッダーを受け取ります - リクエストヘッダーとCookieパラメータは、クエリパラメータと同じ検証ルールをサポートします