第一章：请求体参数基础
1.1 什么是请求体参数？
请求体参数是 RESTful API 中用于传递复杂数据的变量，通常出现在 POST、PUT 等请求的请求体中。例如，创建用户时传递的用户信息就是请求体参数。

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class User(BaseModel):
    name: str
    age: int


@app.post("/users/")
async def create_user(user: User):
    return user

1.2 Pydantic 模型基础
Pydantic 模型用于定义请求体参数的结构和校验规则。通过继承 BaseModel，可以轻松定义模型类。

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


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

示例请求：

{
  "name": "Foo",
  "price": 45.2,
  "tax": 3.2
}

1.3 数据校验
Pydantic 模型支持多种数据校验规则，如 Field、constr 等。

from pydantic import Field, constr


class Product(BaseModel):
    name: constr(min_length=3, max_length=50)
    price: float = Field(..., gt=0)
    description: str = Field(None, max_length=100)


@app.post("/products/")
async def create_product(product: Product):
    return product

示例请求：

合法：{"name": "Laptop", "price": 999.99} → 返回产品信息
非法：{"name": "A", "price": -10} → 422 错误
1.4 常见错误与解决方案
错误：422 Validation Error
原因：请求体参数类型转换失败或校验不通过
解决方案：检查请求体参数的类型定义和校验规则。

第二章：嵌套模型
2.1 什么是嵌套模型？
嵌套模型是指在一个模型中包含另一个模型，用于表示复杂的数据结构。

class Address(BaseModel):
    street: str
    city: str
    state: str
    zip_code: str


class User(BaseModel):
    name: str
    age: int
    address: Address

2.2 嵌套模型的使用
通过嵌套模型，可以处理复杂的请求体参数。

@app.post("/users/")
async def create_user(user: User):
    return user

示例请求：

{
  "name": "John Doe",
  "age": 30,
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "state": "CA",
    "zip_code": "12345"
  }
}

2.3 嵌套模型的校验
嵌套模型同样支持数据校验。

class OrderItem(BaseModel):
    name: str
    quantity: int = Field(..., gt=0)
    price: float = Field(..., gt=0)


class Order(BaseModel):
    items: List[OrderItem]
    total: float = Field(..., gt=0)


@app.post("/orders/")
async def create_order(order: Order):
    return order

示例请求：

合法：{"items": [{"name": "Laptop", "quantity": 1, "price": 999.99}], "total": 999.99} → 返回订单信息
非法：{"items": [{"name": "Laptop", "quantity": 0, "price": 999.99}], "total": 999.99} → 422 错误
2.4 常见错误与解决方案
错误：422 Validation Error
原因：嵌套模型校验失败
解决方案：检查嵌套模型的校验规则。

第三章：高级用法与最佳实践
3.1 模型继承
通过模型继承，可以复用已有的模型定义。

class BaseUser(BaseModel):
    email: str
    password: str


class UserCreate(BaseUser):
    name: str


@app.post("/users/")
async def create_user(user: UserCreate):
    return user

3.2 模型配置
通过 Config 类，可以配置模型的行为，如别名生成、额外字段处理等。

class Item(BaseModel):
    name: str
    description: str = None

    class Config:
        alias_generator = lambda x: x.upper()
        allow_population_by_field_name = True


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

3.3 模型文档
通过 Field 的 description 参数，可以为模型字段添加描述信息，这些信息将显示在 API 文档中。

class Product(BaseModel):
    name: str = Field(..., description="产品名称")
    price: float = Field(..., description="产品价格", gt=0)


@app.post("/products/")
async def create_product(product: Product):
    return product

3.4 常见错误与解决方案
错误：422 Validation Error
原因：模型校验失败
解决方案：检查模型的校验规则和配置。

课后测验
测验 1：请求体参数校验
问题：如何定义一个包含校验规则的请求体参数？
答案：

from pydantic import BaseModel, Field


class Item(BaseModel):
    name: str = Field(..., min_length=3)
    price: float = Field(..., gt=0)


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

测验 2：嵌套模型
问题：如何定义一个嵌套模型？
答案：

class Address(BaseModel):
    street: str
    city: str


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


@app.post("/users/")
async def create_user(user: User):
    return user

错误代码应急手册

from enum import Enum


class Status(str, Enum):
    ACTIVE = "active"
    INACTIVE = "inactive"


class User(BaseModel):
    name: str
    status: Status


@app.post("/users/")
async def create_user(user: User):
    return user

Q：如何处理嵌套模型的默认值？
A：在嵌套模型中为字段设置默认值：

class Address(BaseModel):
    street: str
    city: str = "Anytown"


class User(BaseModel):
    name: str
    address: Address = Address(street="123 Main St")


@app.post("/users/")
async def create_user(user: User):
    return user

通过详细讲解和实战项目，您已掌握 FastAPI 请求体参数与 Pydantic 模型的核心知识。现在可以通过以下命令测试您的学习成果：

curl -X POST "http://localhost:8000/users/" -H "Content-Type: application/json" -d '{"name": "John Doe", "age": 30, "address": {"street": "123 Main St", "city": "Anytown", "state": "CA", "zip_code": "12345"}}'

本文作者： Amd794
本文链接： https://www.cnblogs.com/Amd794/p/18756827