FastAPI 实战：高效构建 Web API 并集成 MySQL 数据库

2025年10月17日 互联网

FastAPI 实战：高效构建 Web API 并集成 MySQL 数据库

在当今快速迭代的软件开发环境中，高效构建 Web API 成为了开发者的重要技能。FastAPI，作为一个现代、快速（高性能）的 Web 框架，基于标准 Python 类型提示构建，因其简洁性、高性能和易用性而广受好评。本文将深入探讨如何使用 FastAPI 快速开发 Web API 项目，并详细介绍如何连接 MySQL 数据库，为你的项目提供稳定的数据存储支持。

一、FastAPI 简介与优势

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 Web 框架，使用 Python 3.6+ 并基于标准 Python 类型提示。它的主要优势包括：

  • 高性能：FastAPI 基于 Starlette 和 Pydantic，提供了接近 ASGI 服务器极限的性能。
  • 快速编码：减少代码重复，提高开发效率。
  • 少 bug：类型检查和自动文档生成有助于减少错误。
  • 直观：API 的编写方式接近于 Python 的函数定义，易于理解和维护。
  • 自动文档：内置支持 OpenAPI 和 JSON Schema，自动生成交互式 API 文档。

二、环境准备与项目初始化

1. 环境准备

在开始之前，确保你的开发环境中已安装 Python 3.6 或更高版本。此外，推荐使用虚拟环境来管理项目依赖，避免不同项目间的依赖冲突。

  1. # 创建虚拟环境
  2. python -m venv fastapi_env
  4. # 激活虚拟环境
  5. # Windows
  6. fastapi_env\Scripts\activate
  7. # macOS/Linux
  8. source fastapi_env/bin/activate

2. 安装 FastAPI 和 Uvicorn

Uvicorn 是一个 ASGI 服务器，用于运行 FastAPI 应用。

  1. pip install fastapi uvicorn

3. 初始化项目结构

一个良好的项目结构有助于代码的组织和维护。以下是一个基本的 FastAPI 项目结构示例：

  1. fastapi_mysql_project/
  2. │
  3. ├── app/
  4. │   ├── __init__.py
  5. │   ├── main.py          # 入口文件
  6. │   ├── models.py        # 数据库模型
  7. │   ├── schemas.py       # Pydantic 模型（用于请求/响应验证）
  8. │   ├── crud.py          # 数据库操作（CRUD）
  9. │   └── database.py      # 数据库连接与会话管理
  10. │
  11. ├── requirements.txt     # 项目依赖
  12. └── README.md            # 项目说明

三、连接 MySQL 数据库

1. 安装 MySQL 驱动

使用 pymysql 或 mysql-connector-python 作为 MySQL 的 Python 驱动。这里以 pymysql 为例：

  1. pip install pymysql sqlalchemy

sqlalchemy 是一个强大的 SQL 工具包和 ORM（对象关系映射）框架，将与 pymysql 一起使用来管理数据库连接和操作。

2. 配置数据库连接

在 app/database.py 中配置数据库连接：

  1. from sqlalchemy import create_engine
  2. from sqlalchemy.ext.declarative import declarative_base
  3. from sqlalchemy.orm import sessionmaker
  5. # 数据库连接字符串，根据实际情况修改
  6. DATABASE_URL = "mysql+pymysql://username:password@localhost/dbname"
  8. engine = create_engine(
  9.     DATABASE_URL,
  10.     echo=True  # 打印 SQL 语句，生产环境中可设为 False
  11. )
  13. SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
  15. Base = declarative_base()

3. 定义数据库模型

在 app/models.py 中定义你的数据库模型。例如，创建一个简单的用户模型：

  1. from sqlalchemy import Column, Integer, String
  2. from .database import Base
  4. class User(Base):
  5.     __tablename__ = "users"
  7.     id = Column(Integer, primary_key=True, index=True)
  8.     name = Column(String, index=True)
  9.     email = Column(String, unique=True, index=True)

4. 创建数据库表

在项目启动时，确保数据库表已创建。可以在 app/main.py 或单独的脚本中执行以下代码：

  1. from app.database import engine, Base
  2. from app.models import Base  # 确保导入所有模型以创建表
  4. # 创建所有表
  5. Base.metadata.create_all(bind=engine)

5. 实现 CRUD 操作

在 app/crud.py 中实现基本的 CRUD（创建、读取、更新、删除）操作：

  1. from sqlalchemy.orm import Session
  2. from . import models, schemas
  4. def get_user(db: Session, user_id: int):
  5.     return db.query(models.User).filter(models.User.id == user_id).first()
  7. def get_users(db: Session, skip: int = 0, limit: int = 100):
  8.     return db.query(models.User).offset(skip).limit(limit).all()
  10. def create_user(db: Session, user: schemas.UserCreate):
  11.     db_user = models.User(name=user.name, email=user.email)
  12.     db.add(db_user)
  13.     db.commit()
  14.     db.refresh(db_user)
  15.     return db_user

6. 创建 API 端点

在 app/main.py 中创建 FastAPI 应用并定义 API 端点：

  1. from fastapi import FastAPI, Depends, HTTPException
  2. from sqlalchemy.orm import Session
  3. from . import crud, models, schemas
  4. from .database import SessionLocal
  6. app = FastAPI()
  8. # 依赖项，用于获取数据库会话
  9. def get_db():
  10.     db = SessionLocal()
  11.     try:
  12.         yield db
  13.     finally:
  14.         db.close()
  16. @app.post("/users/", response_model=schemas.User)
  17. def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)):
  18.     db_user = crud.get_user_by_email(db, email=user.email)
  19.     if db_user:
  20.         raise HTTPException(status_code=400, detail="Email already registered")
  21.     return crud.create_user(db=db, user=user)
  23. @app.get("/users/{user_id}", response_model=schemas.User)
  24. def read_user(user_id: int, db: Session = Depends(get_db)):
  25.     db_user = crud.get_user(db, user_id=user_id)
  26.     if db_user is None:
  27.         raise HTTPException(status_code=404, detail="User not found")
  28.     return db_user

7. 运行应用

使用 Uvicorn 运行你的 FastAPI 应用：

  1. uvicorn app.main:app --reload

--reload 参数会在代码更改时自动重启服务器，适合开发环境。

四、总结与展望

通过本文的介绍，你已经掌握了如何使用 FastAPI 快速开发 Web API 项目，并成功连接了 MySQL 数据库。FastAPI 的高性能、易用性和丰富的功能使得它成为构建现代 Web API 的理想选择。随着项目的扩展，你可以进一步探索 FastAPI 的高级特性，如依赖注入、中间件、安全认证等，以提升项目的安全性和可维护性。

同时，MySQL 数据库的稳定性和灵活性为你的项目提供了可靠的数据存储解决方案。通过合理设计数据库模型和优化查询语句，你可以确保项目在处理大量数据时依然保持高效。

希望本文能为你的 FastAPI 和 MySQL 集成之路提供有益的指导，助你快速构建出高效、稳定的 Web API 项目。

最新文章