FastAPI 学习之路（十）请求体的字段（上）

最新推荐文章于 2025-06-17 11:28:45 发布

原创

最新推荐文章于 2025-06-17 11:28:45 发布 · 424 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#fastapi

本文介绍如何在FastAPI中使用Pydantic的Field进行数据验证及元数据声明，通过示例展示了如何为模型字段设置描述、长度限制及数值范围约束。

与使用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还是一个参数组