FastAPI 快速开发 Web API 项目：连接 MySQL 数据库指南

在当今快速迭代的软件开发环境中，FastAPI 以其高性能、易用性和丰富的功能集，成为了构建 Web API 项目的热门选择。它不仅支持异步请求处理，还能自动生成交互式 API 文档，极大地提升了开发效率。本文将深入探讨如何使用 FastAPI 快速开发一个 Web API 项目，并重点介绍如何连接 MySQL 数据库，实现数据的持久化存储。

一、环境准备与依赖安装

1.1 环境准备

在开始之前，确保你的开发环境中已经安装了 Python（建议使用 Python 3.7+ 版本）。此外，一个合适的代码编辑器（如 VSCode、PyCharm）和虚拟环境管理工具（如 venv 或 conda）也是必不可少的。

1.2 依赖安装

FastAPI 项目依赖于几个关键库，包括 FastAPI 本身、用于处理 HTTP 请求的 Uvicorn 服务器、以及用于数据库操作的 SQLAlchemy 和 PyMySQL（或 mysqlclient）。

pip install fastapi uvicorn sqlalchemy pymysql

二、项目结构规划

一个良好的项目结构有助于代码的维护和扩展。一个典型的 FastAPI 项目可能包含以下目录和文件：

• app/：主应用目录
  • main.py：FastAPI 应用入口
  • models/：数据库模型定义
  • schemas/：Pydantic 模型定义（用于数据验证和序列化）
  • routers/：API 路由定义
  • database.py：数据库连接和会话管理
  • config.py：配置文件（如数据库连接字符串）

三、连接 MySQL 数据库

3.1 配置数据库连接

在 config.py 中定义数据库连接字符串：

# config.py
DATABASE_URL = "mysql+pymysql://username:password@localhost/dbname"

确保替换 username、password、localhost 和 dbname 为你的 MySQL 数据库的实际信息。

3.2 初始化数据库引擎和会话

在 database.py 中，使用 SQLAlchemy 创建数据库引擎和会话工厂：

# database.py
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker, declarative_base
from config import DATABASE_URL
engine = create_engine(DATABASE_URL)
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
Base = declarative_base()

3.3 定义数据库模型

在 models/ 目录下，定义与数据库表对应的模型类。例如，定义一个 User 模型：

# models/user.py
from sqlalchemy import Column, Integer, String
from database import Base
class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True, index=True)
    name = Column(String, index=True)
    email = Column(String, unique=True, index=True)

别忘了在应用启动时创建表（可以在 main.py 或专门的初始化脚本中完成）：

# main.py 或初始化脚本
from database import engine, Base
from models.user import User  # 导入所有模型以确保它们被注册
Base.metadata.create_all(bind=engine)

四、实现 API 路由

在 routers/ 目录下，定义处理 HTTP 请求的路由。例如，创建一个处理用户相关操作的路由：

# routers/user.py
from fastapi import APIRouter, HTTPException
from sqlalchemy.orm import Session
from models.user import User
from schemas.user import UserCreate, User as UserSchema  # 假设有对应的 Pydantic 模型
from database import SessionLocal
router = APIRouter()
def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()
@router.post("/users/", response_model=UserSchema)
def create_user(user: UserCreate, db: Session = Depends(get_db)):
    db_user = User(name=user.name, email=user.email)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)
    return db_user
@router.get("/users/{user_id}", response_model=UserSchema)
def read_user(user_id: int, db: Session = Depends(get_db)):
    db_user = db.query(User).filter(User.id == user_id).first()
    if db_user is None:
        raise HTTPException(status_code=404, detail="User not found")
    return db_user

五、启动 FastAPI 应用

在 main.py 中，整合所有组件并启动 FastAPI 应用：

# main.py
from fastapi import FastAPI
from routers.user import router as user_router
app = FastAPI()
app.include_router(user_router)
if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

六、测试与验证

启动应用后，你可以使用 curl、Postman 或任何 HTTP 客户端来测试你的 API。例如，创建一个新用户：

curl -X POST "http://localhost:8000/users/" -H "Content-Type: application/json" -d '{"name":"John Doe","email":"john@example.com"}'

或者查询一个用户：

curl "http://localhost:8000/users/1"

七、进阶与优化

7.1 异步数据库操作

FastAPI 支持异步请求处理，你可以利用 async/await 语法和异步数据库驱动（如 asyncpg 对于 PostgreSQL，或 aiomysql 对于 MySQL）来进一步提升性能。

7.2 中间件与依赖注入

FastAPI 提供了强大的中间件和依赖注入系统，可以用来处理认证、日志记录、数据库会话管理等横切关注点。

7.3 安全性与验证

利用 FastAPI 的内置功能或第三方库（如 python-jose 用于 JWT 认证）来增强 API 的安全性。

八、总结

通过本文的介绍，你已经掌握了如何使用 FastAPI 快速开发一个 Web API 项目，并成功连接 MySQL 数据库。FastAPI 的简洁性、高性能和丰富的功能集使得它成为构建现代 Web 服务的理想选择。随着你对 FastAPI 的深入了解，你将能够构建出更加复杂、高效和安全的 API 服务。