FastAPI 如何使用 Pydantic 进行数据验证？

推荐答案

在 FastAPI 中，Pydantic 是一个强大的库，用于数据验证和设置管理。FastAPI 内置了对 Pydantic 的支持，允许你通过定义 Pydantic 模型来验证请求和响应的数据。

示例代码

// www.javascriptcn.com code example
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    description: str = None
    price: float
    tax: float = None

@app.post("/items/")
async def create_item(item: Item):
    return item

解释

1. 定义 Pydantic 模型：我们定义了一个 Item 类，继承自 BaseModel。这个类定义了请求体的结构，包括字段的类型和默认值。

2. 使用模型作为参数：在路由处理函数 create_item 中，我们将 Item 模型作为参数类型。FastAPI 会自动解析请求体，并根据 Item 模型进行数据验证。

3. 自动验证：如果请求体不符合 Item 模型的定义，FastAPI 会自动返回一个 422 Unprocessable Entity 错误，并附带详细的错误信息。

本题详细解读

Pydantic 模型的作用

Pydantic 模型在 FastAPI 中主要用于数据验证和序列化。通过定义模型，你可以确保传入的数据符合预期的格式和类型。Pydantic 还支持复杂的嵌套模型、自定义验证器等功能。

数据验证流程

1. 请求解析：当客户端发送一个 POST 请求到 /items/ 时，FastAPI 会解析请求体。

2. 数据验证：FastAPI 会根据 Item 模型的定义，验证请求体中的每个字段。如果字段类型不匹配或缺少必填字段，FastAPI 会返回错误。

3. 数据转换：如果请求体通过验证，FastAPI 会将 JSON 数据转换为 Item 实例，并将其传递给路由处理函数。

4. 响应生成：路由处理函数可以返回 Item 实例，FastAPI 会自动将其序列化为 JSON 并返回给客户端。

错误处理

如果数据验证失败，FastAPI 会返回一个 422 Unprocessable Entity 错误，响应体中包含详细的错误信息，例如：

// www.javascriptcn.com code example
{
  "detail": [
    {
      "loc": ["body", "price"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

这个错误信息可以帮助开发者快速定位问题所在。

高级用法

Pydantic 还支持许多高级功能，如：

• 嵌套模型：可以在模型中嵌套其他模型，用于处理复杂的数据结构。
• 自定义验证器：可以通过 @validator 装饰器定义自定义验证逻辑。
• 字段别名：可以通过 Field 类为字段定义别名，用于处理 JSON 中的不同命名约定。

这些功能使得 Pydantic 在 FastAPI 中成为一个非常灵活和强大的工具。