Header 参数¶
你可以像定义 Query、Path 和 Cookie 参数一样定义 Header 参数。
导入 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}
提示
如果可能，请优先使用 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}
提示
如果可能，请优先使用 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 相同的结构来声明 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}
提示
如果可能，请优先使用 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}
提示
如果可能，请优先使用 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 等时，它们实际上是返回特殊类的函数。
信息
要声明 Header，你需要使用 Header，否则参数将被解释为查询参数。
自动转换¶
Header 在 Path、Query 和 Cookie 提供的功能之上，增加了一些额外功能。
大多数标准的 Header 之间用“连字符”（也称为“减号”）分隔 (-)。
但是像 user-agent 这样的变量在 Python 中是无效的。
因此，默认情况下，Header 会将参数名称中的下划线 (_) 转换为连字符 (-)，以便提取和记录 Header。
此外，HTTP Header 是不区分大小写的，所以你可以使用标准的 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}
提示
如果可能，请优先使用 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}
提示
如果可能，请优先使用 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}
警告
在将 convert_underscores 设置为 False 之前，请牢记，某些 HTTP 代理和服务器不允许使用带有下划线的 Header。
重复的 Header¶
有可能接收到重复的 Header。也就是说，同一个 Header 有多个值。
你可以使用类型声明中的列表来定义这些情况。
你将收到重复 Header 的所有值，作为一个 Python list。
例如，要声明一个可以出现多次的 X-Token Header，你可以这样写：
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, 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}
提示
如果可能，请优先使用 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}
提示
如果可能，请优先使用 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}
如果你向该路径操作发送两个像这样的 HTTP Header：
X-Token: foo
X-Token: bar
响应将如下所示：
{
"X-Token values": [
"bar",
"foo"
]
}
总结¶
使用 Header 声明 Header，使用与 Query、Path 和 Cookie 相同的通用模式。
并且不用担心变量中的下划线，FastAPI 会负责转换它们。