FastAPI 学习之路(十)请求体的字段(上)

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

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

与使用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类。

### FastAPI请求体的使用方法 在 FastAPI 中,请求体通常通过 `Pydantic` 模型来定义和验证。以下是关于如何处理请求体的具体说明以及示例。 #### 定义请求体模型 为了声明请求体,可以使用 `Pydantic` 提供的 `BaseModel` 类创建数据模型。这些模型不仅用于描述数据结构,还能够提供自动化的数据验证功能[^1]。 ```python from pydantic import BaseModel class Item(BaseModel): name: str description: str | None = None price: float tax: float | None = None ``` 上述代码片段展示了如何定义一个名为 `Item` 的模型,该模型包含了四个字段:`name`(必需)、`description`(可选,默认为 `None`)、`price`(必需)和 `tax`(可选,默认为 `None`)。此模型可用于解析 JSON 数据并将其映射到 Python 对象中。 #### 处理 POST 请求中的请求体 当需要接收来自客户端的复杂数据时,可以通过函数参数指定对应的 `Pydantic` 模型作为输入类型。FastAPI 将自动读取 HTTP 请求正文中的 JSON 数据,并尝试将其解码为所定义的模型实例。 ```python from fastapi import FastAPI app = FastAPI() @app.post("/items/") async def create_item(item: Item): return item ``` 在此例子中,`create_item` 函数接受了一个类型为 `Item` 的参数 `item`。这意味着每当调用 `/items/` 路由时,FastAPI 都会期望接收到符合 `Item` 结构的有效 JSON 数据。 #### 嵌套请求体的支持 如果希望将整个对象嵌入另一个键下,则需调整前端发送的数据格式。在这种情况下,即使后端保持相同的模型定义不变,也需要确保传来的 JSON 是按照特定形式组织的。例如: 假设我们有一个如下所示的新路由: ```python @app.put("/complex-item/") async def update_complex_item(complex_data: dict): inner_item = complex_data["item"] return {"received": inner_item} ``` 此时,客户端应提交形如 `{ "item": {...} }` 这样的 JSON 数据,其中内部的对象遵循之前定义好的 `Item` 模型规则[^3]。 #### 综合应用案例 下面给出一个更完整的综合应用场景,它结合了路径参数、查询字符串参数与请求体一起使用的场景[^4]: ```python from fastapi import FastAPI, Query from typing import Optional app = FastAPI() fake_db = {} @app.post("/products/{category}/") async def add_product( category: str, product_name: str = Query(..., min_length=3), details: Item ): key = f"{category}-{product_name}" fake_db[key] = details.dict() return {"status": "success", "stored_key": key} ``` 在这个样例里,除了常规的请求体外,还有两个其他类型的参数被引入——一个是 URL 路径的一部分 (`category`);另一个是从查询串提取出来的值(`product_name`)。 --- ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值