头部参数¶
你可以像定义 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}
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}
from typing import Union
from fastapi import FastAPI, Header
from typing_extensions import Annotated
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Annotated[Union[str, None], Header()] = None):
return {"User-Agent": user_agent}
Tip
如果可能，建议使用 Annotated 版本。
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
如果可能，建议使用 Annotated 版本。
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}
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}
from typing import Union
from fastapi import FastAPI, Header
from typing_extensions import Annotated
app = FastAPI()
@app.get("/items/")
async def read_items(user_agent: Annotated[Union[str, None], Header()] = None):
return {"User-Agent": user_agent}
Tip
如果可能，建议使用 Annotated 版本。
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
如果可能，建议使用 Annotated 版本。
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 类。
但请记住，当你从 fastapi 导入 Query、Path、Header 等时，这些实际上是返回特殊类的函数。
Info
要声明头部参数，你需要使用 Header，否则这些参数将被解释为查询参数。
自动转换¶
Header 在 Path、Query 和 Cookie 提供的基础上有一些额外的功能。
大多数标准头部由“连字符”字符分隔，也称为“减号符号”（-）。
但像 user-agent 这样的变量在 Python 中是无效的。
因此，默认情况下，Header 会将参数名称中的下划线（_）转换为连字符（-）以提取和记录头部。
此外，HTTP 头部是不区分大小写的，因此你可以使用标准的 Python 样式（也称为“snake_case”）来声明它们。
因此，你可以像在 Python 代码中通常那样使用 user_agent，而不需要将首字母大写为 User_Agent 或类似的形式。
如果由于某种原因你需要禁用下划线到连字符的自动转换，请将 Header 的参数 convert_underscores 设置为 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}
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}
from typing import Union
from fastapi import FastAPI, Header
from typing_extensions import Annotated
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
如果可能，建议使用 Annotated 版本。
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
如果可能，建议使用 Annotated 版本。
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}
Warning
在将 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}
from typing import Annotated, List, 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}
from typing import List, Union
from fastapi import FastAPI, Header
from typing_extensions import Annotated
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
如果可能，建议使用 Annotated 版本。
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
如果可能，请优先使用 Annotated 版本。
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}
Tip
如果可能，请优先使用 Annotated 版本。
from typing import List, 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 会帮你处理转换。