FastAPI 在FastAPI中测试Pydantic设置

在本文中，我们将介绍如何在FastAPI中测试Pydantic设置。FastAPI是一个快速（高性能）的Web框架，用于构建API，而Pydantic是一个用于数据验证和设置的库。结合使用这两个工具可以轻松地构建和测试API端点。

阅读更多：FastAPI 教程

安装

首先，我们需要安装FastAPI和Pydantic。可以使用以下命令来安装它们：

pip install fastapi
pip install pydantic

另外，我们还需要安装pytest和httpx以进行单元测试：

pip install pytest
pip install httpx

创建一个FastAPI应用程序和设置模型

让我们开始创建一个简单的FastAPI应用程序并定义一个设置模型。首先，创建一个名为main.py的文件，并添加以下代码：

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Settings(BaseModel):
    api_key: str
    timeout: int


SETTINGS = Settings(api_key="my_secret_key", timeout=10)


@app.get("/settings")
async def read_settings():
    return SETTINGS

在上面的代码中，我们导入了FastAPI和Pydantic，并创建了一个FastAPI实例。然后，我们定义了一个名为Settings的Pydantic模型，它具有api_key和timeout属性。我们还创建了一个名为SETTINGS的全局实例，其中包含我们的默认设置。最后，我们创建了一个名为read_settings的路由，并在其中返回设置。

编写测试

现在，我们已经定义了我们的FastAPI应用程序和设置模型，让我们编写一些测试用例来测试它们。创建一个名为test_main.py的文件，并添加以下代码：

from fastapi.testclient import TestClient

from main import app, SETTINGS


def test_read_settings():
    client = TestClient(app)
    response = client.get("/settings")
    assert response.status_code == 200
    assert response.json() == SETTINGS.dict()

在上面的代码中，我们导入了TestClient类以进行FastAPI的测试。然后，我们定义了一个名为test_read_settings的测试函数，并在其中创建一个TestClient实例。最后，我们使用该客户端发送一个GET请求到/settings路由，并使用断言来验证响应状态码和返回的JSON数据是否与设置匹配。

运行测试

现在，我们可以使用pytest来运行我们的测试。在命令行中，导航到包含test_main.py文件的文件夹，并运行以下命令：

pytest

这将运行我们的测试用例，并输出测试结果。

总结

在本文中，我们介绍了如何在FastAPI中测试Pydantic设置。我们首先安装了FastAPI和Pydantic，并创建了一个简单的FastAPI应用程序和一个设置模型。然后，我们使用pytest和TestClient来编写和运行测试。使用这些工具，我们可以确保我们的API端点在使用Pydantic设置时正常运行。快乐编码！

注意：Pydantic是FastAPI的默认设置验证库，并且已经被集成到FastAPI中。因此，在FastAPI中使用Pydantic设置时，不需要额外的设置验证库。