在 FastAPI 中，`Pydantic` 的 `BaseModel` 是用来定义请求参数的模型类。通过继承 `BaseModel`，你可以为 API 定义结构化、类型安全的输入数据模型。以下是使用 `BaseModel` 传入参数的详细示例。 --- ### 示例：定义一个带有 `BaseModel` 参数的 FastAPI 接口 ```python from fastapi import FastAPI from pydantic import BaseModel # 创建 FastAPI 实例 app = FastAPI() # 定义一个 Pydantic 模型类 class Item(BaseModel): name: str description: str = None # 可选字段 price: float tax: float = None # 可选字段 # 定义 POST 请求接口 @app.post("/items/") async def create_item(item: Item): # 返回接收到的数据 return { "name": item.name, "description": item.description, "price": item.price, "tax": item.tax, "total_price": item.price + (item.tax if item.tax else 0) } ``` --- ### 上述代码解释 1. **定义 `BaseModel` 子类**： - `Item` 类继承自 `BaseModel`。 - 定义了四个字段：`name`（必填）、`description`（可选，默认值为 `None`）、`price`（必填）和 `tax`（可选，默认值为 `None`）。 - 使用类型注解（如 `str`、`float`）指定字段的数据类型。 2. **FastAPI 路由**： - `@app.post("/items/")` 定义了一个 POST 请求路由 `/items/`。 - `create_item` 函数接收一个 `item` 参数，其类型为 `Item`。 - FastAPI 会自动解析请求体中的 JSON 数据，并将其映射到 `Item` 模型中。 3. **返回结果**： - 返回一个字典，包含接收到的数据以及计算出的总价格（`price + tax`）。 --- ### 测试接口 可以使用 `curl` 或 Postman 测试该接口。以下是一个 `curl` 命令示例： ```bash curl -X POST http://127.0.0.1:8000/items/ \ -H "Content-Type: application/json" \ -d '{"name": "Foo", "description": "A very nice Item", "price": 45.2, "tax": 3.5}' ``` 返回结果示例： ```json { "name": "Foo", "description": "A very nice Item", "price": 45.2, "tax": 3.5, "total_price": 48.7 } ``` --- ### 注意事项 1. **字段验证**： - 如果请求体中的字段不符合 `BaseModel` 的定义（如类型错误或缺少必填字段），FastAPI 会自动返回 422 错误（Unprocessable Entity），并附带详细的错误信息。 2. **嵌套模型**： - `BaseModel` 支持嵌套模型。例如，如果某个字段是一个对象，可以为其定义另一个 `BaseModel` 子类。 3. **默认值**： - 对于可选字段，可以通过赋值 `= None` 或其他默认值来指定默认行为。 --- ### 嵌套模型示例 以下是一个更复杂的嵌套模型示例： ```python from fastapi import FastAPI from pydantic import BaseModel app = FastAPI() # 定义嵌套模型 class Address(BaseModel): street: str city: str country: str class User(BaseModel): name: str age: int address: Address # 嵌套模型 @app.post("/users/") async def create_user(user: User): return user ``` 测试数据： ```json { "name": "Alice", "age": 30, "address": { "street": "123 Main St", "city": "Wonderland", "country": "Neverland" } } ``` ---