FastAPI与MySQL的集成详解

概述

FastAPI是一个现代、快速（高性能）的Web框架，用于构建API。它建立在Starlette和Pydantic之上，以提供更好的性能和代码自动生成。FastAPI支持与各种数据库系统集成，其中包括MySQL。

MySQL是一个开源的关系型数据库管理系统，具有广泛的应用领域。它提供了强大的功能，如事务处理、数据完整性保护和高可用性。

本文将详细介绍如何将FastAPI与MySQL集成，以便开发功能强大的Web应用程序。

环境准备

在开始之前，我们需要准备以下环境：

• Python 3.7+
• FastAPI
• MySQL数据库

安装依赖

首先，我们需要安装FastAPI和PyMySQL依赖：

pip install fastapi
pip install "fastapi[all]"
pip install pymysql

创建数据库

在MySQL中创建一个新的数据库，用于存储我们的数据。可以使用MySQL的命令行工具或可视化工具（如phpMyAdmin）执行以下SQL命令：

CREATE DATABASE fastapi_mysql;

连接MySQL数据库

在FastAPI中，我们使用PyMySQL库来连接和操作MySQL数据库。首先，我们需要导入必要的模块和库：

from fastapi import FastAPI
import pymysql

# 创建FastAPI实例
app = FastAPI()

# 创建MySQL连接
connection = pymysql.connect(
    host="localhost",
    user="root",
    password="your_password",
    database="fastapi_mysql"
)

请确保将 your_password 替换为你的MySQL密码，并根据需要进行其他配置更改（例如主机和数据库名）。

定义数据库模型

在FastAPI中，我们使用Pydantic库来定义数据模型，并将其映射到数据库中的表。创建一个新的Python文件，例如 models.py，并添加以下代码：

from pydantic import BaseModel

# 创建数据模型
class User(BaseModel):
    id: int
    name: str
    email: str

在这个示例中，我们定义了一个 User 模型，用于表示用户数据。模型中的字段与数据库表中的列一一对应。

创建API路由

接下来，我们需要为API创建路由。在FastAPI中，我们使用装饰器来定义路由和处理程序。在我们的示例中，我们将创建一个用于获取所有用户的路由。

在主文件中添加以下代码：

from fastapi import FastAPI
import pymysql

# 导入数据模型
from models import User

# 创建FastAPI实例
app = FastAPI()

# 创建MySQL连接
connection = pymysql.connect(
    host="localhost",
    user="root",
    password="your_password",
    database="fastapi_mysql"
)

# 定义路由
@app.get("/users")
async def get_users():
    # 创建游标
    with connection.cursor() as cursor:
        # 执行SQL查询
        cursor.execute("SELECT * FROM users")

        # 获取查询结果
        result = cursor.fetchall()

        # 将结果映射到数据模型
        users = [User(id=row[0], name=row[1], email=row[2]) for row in result]

        # 返回结果
        return users

这个示例中，我们创建了一个GET请求的路由 /users，用于获取所有用户的数据。我们使用MySQL连接的游标对象执行一个查询，并将结果映射到数据模型中的对象中。最后，我们将用户列表返回给客户端。

运行FastAPI应用

现在，我们已经完成了FastAPI与MySQL的集成配置。打开终端，进入项目文件夹，并运行以下命令启动FastAPI应用：

uvicorn main:app --reload

其中 main 是主文件的名称，app 是FastAPI实例名称。--reload 参数用于在代码更改时自动重载应用程序。

测试API

现在，我们可以使用任何API测试工具（如Postman或curl命令）来测试我们的API。发送GET请求到 http://localhost:8000/users，应该能够获取到所有用户的数据。

以下是一个使用curl命令测试API的示例：

curl http://localhost:8000/users

代码运行的结果应该类似于以下输出：

[{"id": 1, "name": "John Doe", "email": "john.doe@example.com"}, {"id": 2, "name": "Jane Smith", "email": "jane.smith@example.com"}]

总结

本文详细介绍了如何在FastAPI中集成MySQL数据库。我们使用PyMySQL库连接和操作MySQL数据库，并使用Pydantic库定义数据模型。通过这种集成，我们可以轻松地构建强大的Web应用程序，并与MySQL数据库交互。