FastAPI 如何进行数据验证？

推荐答案

在 FastAPI 中，数据验证主要通过 Pydantic 模型来实现。Pydantic 是一个数据验证和设置管理的库，FastAPI 内置了对 Pydantic 的支持。通过定义 Pydantic 模型，FastAPI 可以自动验证请求数据，并在数据不符合预期时返回详细的错误信息。

以下是一个简单的示例，展示了如何在 FastAPI 中使用 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

在这个示例中，Item 是一个 Pydantic 模型，定义了请求体的结构。FastAPI 会自动验证传入的 JSON 数据是否符合 Item 模型的字段类型和约束。如果数据验证失败，FastAPI 会返回一个包含错误信息的 HTTP 400 响应。

本题详细解读

1. Pydantic 模型的定义

Pydantic 模型是通过继承 BaseModel 类来定义的。每个字段都可以指定类型，并且可以设置默认值或可选字段。例如：

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

在这个模型中：

• name 是一个必填的字符串字段。
• description 是一个可选的字符串字段，默认值为 None。
• price 是一个必填的浮点数字段。
• tax 是一个可选的浮点数字段，默认值为 None。

2. 数据验证的过程

当客户端发送一个 POST 请求到 /items/ 路径时，FastAPI 会自动将请求体中的 JSON 数据解析为 Item 模型的实例。如果数据不符合模型的定义，FastAPI 会返回一个包含错误信息的 HTTP 400 响应。

例如，如果客户端发送的 JSON 数据缺少 name 字段，FastAPI 会返回如下错误信息：

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

3. 自定义验证规则

Pydantic 还支持自定义验证规则。可以通过在模型中使用 @validator 装饰器来定义自定义验证逻辑。例如：

// www.javascriptcn.com code example
from pydantic import validator

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

    @validator('price')
    def price_must_be_positive(cls, v):
        if v <= 0:
            raise ValueError('price must be positive')
        return v

在这个示例中，price_must_be_positive 方法确保 price 字段的值必须大于 0。如果 price 的值不满足条件，Pydantic 会抛出一个 ValueError，FastAPI 会将其转换为一个 HTTP 400 响应。

4. 嵌套模型

Pydantic 模型还支持嵌套，允许你定义复杂的数据结构。例如：

// www.javascriptcn.com code example
class Address(BaseModel):
    street: str
    city: str
    state: str
    zip_code: str

class User(BaseModel):
    name: str
    email: str
    address: Address

在这个示例中，User 模型包含一个嵌套的 Address 模型。FastAPI 会自动验证嵌套模型中的字段。

5. 使用 FastAPI 的依赖注入

FastAPI 还支持通过依赖注入来验证请求参数。例如，你可以使用 Query、Path、Body 等依赖项来验证查询参数、路径参数和请求体。例如：

from fastapi import Query

@app.get("/items/")
async def read_items(q: str = Query(..., min_length=3, max_length=50)):
    return {"q": q}

在这个示例中，Query 依赖项确保 q 参数的长度在 3 到 50 个字符之间。如果 q 的长度不符合要求，FastAPI 会返回一个 HTTP 400 响应。

通过以上方式，FastAPI 提供了强大且灵活的数据验证机制，确保应用程序能够处理符合预期的数据，并在数据不符合要求时提供清晰的错误信息。