查询参数模型¶
如果你有一组相关的查询参数，你可以创建一个 Pydantic 模型来声明它们。
这样你就可以在多个地方重用该模型，并且可以一次性声明所有参数的验证和元数据。😎
注意
FastAPI 0.115.0 版本开始支持此功能。🤓
使用 Pydantic 模型的查询参数¶
在 Pydantic 模型中声明你需要的查询参数，然后将该参数声明为 Query。
from typing import Annotated, Literal
from fastapi import FastAPI, Query
from pydantic import BaseModel, Field
app = FastAPI()
class FilterParams(BaseModel):
limit: int = Field(100, gt=0, le=100)
offset: int = Field(0, ge=0)
order_by: Literal["created_at", "updated_at"] = "created_at"
tags: list[str] = []
@app.get("/items/")
async def read_items(filter_query: Annotated[FilterParams, Query()]):
return filter_query
🤓 其他版本和变体
提示
如果可能，请优先使用 Annotated 版本。
from typing import Literal
from fastapi import FastAPI, Query
from pydantic import BaseModel, Field
app = FastAPI()
class FilterParams(BaseModel):
limit: int = Field(100, gt=0, le=100)
offset: int = Field(0, ge=0)
order_by: Literal["created_at", "updated_at"] = "created_at"
tags: list[str] = []
@app.get("/items/")
async def read_items(filter_query: FilterParams = Query()):
return filter_query
FastAPI 将会从请求的查询参数中为每个字段提取数据，并将其转换为你定义的 Pydantic 模型。
查看文档¶
你可以在 /docs 的文档界面中查看这些查询参数。
禁止额外的查询参数¶
在某些特殊用例中（可能不太常见），你可能想要限制所接收的查询参数。
你可以使用 Pydantic 的模型配置来 forbid 任何 extra 字段
from typing import Annotated, Literal
from fastapi import FastAPI, Query
from pydantic import BaseModel, Field
app = FastAPI()
class FilterParams(BaseModel):
model_config = {"extra": "forbid"}
limit: int = Field(100, gt=0, le=100)
offset: int = Field(0, ge=0)
order_by: Literal["created_at", "updated_at"] = "created_at"
tags: list[str] = []
@app.get("/items/")
async def read_items(filter_query: Annotated[FilterParams, Query()]):
return filter_query
🤓 其他版本和变体
提示
如果可能，请优先使用 Annotated 版本。
from typing import Literal
from fastapi import FastAPI, Query
from pydantic import BaseModel, Field
app = FastAPI()
class FilterParams(BaseModel):
model_config = {"extra": "forbid"}
limit: int = Field(100, gt=0, le=100)
offset: int = Field(0, ge=0)
order_by: Literal["created_at", "updated_at"] = "created_at"
tags: list[str] = []
@app.get("/items/")
async def read_items(filter_query: FilterParams = Query()):
return filter_query
如果客户端尝试在查询参数中发送一些额外的数据，他们将收到一个错误响应。
例如，如果客户端尝试发送一个值为 plumbus 的 tool 查询参数，如下所示：
https://example.com/items/?limit=10&tool=plumbus
他们将收到一个错误响应，告知他们不允许使用查询参数 tool。
{
"detail": [
{
"type": "extra_forbidden",
"loc": ["query", "tool"],
"msg": "Extra inputs are not permitted",
"input": "plumbus"
}
]
}
总结¶
你可以在 FastAPI 中使用 Pydantic 模型来声明查询参数。😎
提示
剧透警告：你也可以使用 Pydantic 模型来声明 Cookie 和 Header，稍后的教程中你会学到这一点。🤫