FastAPI使用Pydantic模型处理JSON数组

在本文中，我们将介绍如何在FastAPI中使用Pydantic模型处理JSON数组。我们将了解如何定义Pydantic模型来表示JSON对象，并如何使用这些模型来处理JSON数组的输入和输出。

什么是FastAPI和Pydantic？

FastAPI是一个基于Python的现代Web框架，它提供了一个快速（fast）和易于使用的方式来构建Web应用程序的API。它基于异步请求处理，并且支持自动文档生成，输入和输出验证，依赖注入等特性。FastAPI使用Pydantic来处理输入和输出数据的验证和转换。

Pydantic是一个用于数据验证和转换的Python库。它提供了一个简单而强大的方式来定义数据模型，并自动执行数据验证和转换操作。

在FastAPI中定义Pydantic模型

要在FastAPI中处理JSON数组，我们首先需要定义一个Pydantic模型来表示一个JSON对象。可以使用Pydantic的BaseModel类来定义模型。

下面是一个示例模型的定义：

from typing import List
from pydantic import BaseModel

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

class Users(BaseModel):
    users: List[User]

在上面的示例中，我们定义了一个User模型来表示一个用户对象，其中包含一个name字段和一个age字段。然后，我们定义了一个Users模型，它包含一个users字段，该字段是一个包含多个User对象的列表。

使用Pydantic模型处理JSON数组输入

要在FastAPI中使用定义的Pydantic模型处理JSON数组输入，我们需要使用Pydantic模型作为请求体的参数类型。

下面是一个使用定义的上述Users模型来处理JSON数组输入的示例：

from fastapi import FastAPI
from typing import List
from pydantic import BaseModel

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

class Users(BaseModel):
    users: List[User]

app = FastAPI()

@app.post("/users")
async def create_users(users: Users):
    for user in users.users:
        # 处理用户对象
        print(user.name, user.age)
    return {"message": "Users created successfully"}

在上面的示例中，我们定义了一个/users的POST请求处理程序，它接受一个Users类型的参数users作为请求体。在处理程序内部，我们可以使用users.users来访问JSON数组中的每个用户对象。

使用Pydantic模型处理JSON数组输出

要在FastAPI中使用定义的Pydantic模型处理JSON数组输出，我们可以将Pydantic模型作为响应体的返回类型。

下面是一个使用定义的上述Users模型来处理JSON数组输出的示例：

from fastapi import FastAPI
from typing import List
from pydantic import BaseModel

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

class Users(BaseModel):
    users: List[User]

app = FastAPI()

@app.get("/users")
async def get_users():
    users_data = [
        {"name": "Alice", "age": 25},
        {"name": "Bob", "age": 30}
    ]
    users = Users(users=users_data)
    return users

在上面的示例中，我们定义了一个/users的GET请求处理程序，它返回一个Users类型的响应体。在处理程序内部，我们可以使用Users模型来创建包含JSON数组的对象，并将其作为响应返回给客户端。

总结

本文介绍了如何在FastAPI中使用Pydantic模型处理JSON数组的输入和输出。我们学习了如何定义Pydantic模型来表示JSON对象，并使用这些模型处理JSON数组的输入和输出。通过使用Pydantic模型，我们可以轻松地进行数据验证和转换，并确保输入和输出数据的准确性和一致性。希望本文能帮助您更好地理解和使用FastAPI和Pydantic。