【进阶】FastAPI中的响应模型

# 1.1 Pydantic模型的定义和验证

Pydantic是一个用于数据验证和类型化的Python库。在FastAPI中，Pydantic模型用于定义和验证API请求和响应的数据结构。

创建Pydantic模型时，需要定义模型的字段、类型和验证规则。例如：

from pydantic import BaseModel

class User(BaseModel):
    username: str
    email: str
    password: str

此模型定义了一个名为`User`的类，其中包含三个字段：`username`（字符串）、`email`（字符串）和`password`（字符串）。

要验证数据，可以使用`User`模型的`validate()`方法。如果数据有效，则返回验证后的数据；否则，抛出`ValidationError`异常。例如：

data = {"username": "john", "email": "john@example.com", "password": "secret"}
user = User(**data)

如果`data`中包含有效数据，则`user`将包含验证后的数据。否则，将抛出`ValidationError`异常。

# 2. FastAPI响应模型的构建

### 2.1 Pydantic模型的创建和使用

#### 2.1.1 Pydantic模型的定义和验证

Pydantic是一个用于数据验证和类型注解的Python库。在FastAPI中，Pydantic模型被用来定义和验证请求和响应的数据结构。

要创建一个Pydantic模型，可以使用`@dataclasses.dataclass`装饰器，并指定模型的字段和类型注解：

from pydantic import BaseModel

class User(BaseModel):
    id: int
    name: str
    email: str

这个模型定义了一个`User`类，它具有三个字段：`id`（整型）、`name`（字符串）和`email`（字符串）。

Pydantic模型提供了一系列内置验证器，用于验证字段的值是否符合指定的类型和约束。例如，`int`类型注解会自动验证字段的值是否为整数。

#### 2.1.2 FastAPI中使用Pydantic模型

在FastAPI中，可以使用`@pydantic. BaseModel`装饰器将Pydantic模型作为请求或响应的数据结构。例如，以下代码定义了一个FastAPI路由，它接收一个`User`模型作为请求体，并返回一个`User`模型作为响应：

from fastapi import FastAPI, Body

app = FastAPI()

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

当客户端向这个路由发送一个POST请求时，FastAPI会自动验证请求体是否符合`User`模型的定义。如果验证通过，FastAPI会将请求体转换为一个`User`实例，并将其传递给路由处理函数。

### 2.2 FastAPI响应模型的自定义

#### 2.2.1 响应模型的装饰器和参数

FastAPI提供了几个装饰器和参数，用于自定义响应模型的行为。例如，`@response_model`装饰器可以指定响应模型的类型：

from fastapi import FastAPI, Body, Response

app = FastAPI()

@app.post("/users")
async def create_user(user: User = Body(...)):
    return Response(content=user.json(), status_code=201)

在这个例子中，`@response_model`装饰器指定了`User`模型作为响应模型。这将导致FastAPI自动将响应转换为JSON格式，并设置状态码为201（已创建）。

#### 2.2.2 响应模型的继承和扩展

FastAPI允许响应模型继承和扩展其他响应模型。例如，以下代码定义了一个`UserWithToken`模型，它继承了`User`模型并添加了一个`token`字段：

from pydantic import BaseModel

class UserWithToken(User):
    token: str

然后，可以在FastAPI路由中使用`UserWithToken`模型作为响应模型：

from fastapi import FastAPI, Body, Response

app = FastAPI()

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