与使用Query,Path,Body 在路径操作函数中声明额外的校验和元数据的方式相同,你可以使用pydantic的Field在pydantic模型内部声明校验和元数据。看个简单的例子:
from fastapi import FastAPI, Body
from typing import Optional
from pydantic import BaseModel, Field
app = FastAPI()
class Item(BaseModel):
name: str
description: Optional[str] = Field(None, title="这里可以写描述", max_length=300)
price: float = Field(..., ge=0, description="价格必须大于0")
tax: Optional[float] = None
@app.put("/items/{itemid}")
def update_items(itemid: int, item: Item = Body(..., embed=True)):
result = {"itemid": itemid, "item": item}
return result
这里还是举的一个物品的价格,还打折的例子,我们对于描述和price用了Field,我们看下效果。我们用postman请求下。问可以看到item还是一个参数组
那么我们看下我们代码中条件,假如,我们现在的价格小于0.
我们可以看到,接口正常给我们返回了不应该小于0。我们可以看下接口文档
Field 的工作方式和 Query、Path 和 Body 相同,包括它们的参数等等也完全相同。
我们可以看下Field的源码。它里面是FieldInfo类实例化,然后校验。
那么我们在来看下boby, Query、Path 方法,
body,是一个方法,他是params的Query方法
我们在往下看,发下,params的body类。