FastAPI-SQLAlchemy 教程

最新推荐文章于 2025-05-23 08:11:44 发布

原创最新推荐文章于 2025-05-23 08:11:44 发布 · 739 阅读

20 ·

CC 4.0 BY-SA版权

FastAPI-SQLAlchemy 教程

fastapi-sqlalchemy Adds simple SQLAlchemy support to FastAPI 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-sqlalchemy

项目介绍

FastAPI-SQLAlchemy 是一个简单集成 FastAPI 和 SQLAlchemy 的库，旨在使在 FastAPI 应用程序中使用 SQLAlchemy 更加便捷。它提供了实用的帮助函数来简化常见的数据库操作任务，支持 SQLite、MySQL 等多种数据库，并且允许开发者方便地进行模型定义和数据库查询。

项目快速启动

安装 FastAPI-SQLAlchemy

首先，确保你已经安装了 FastAPI 和 Uvicorn（虽然本节不涉及其安装，但它们是基础）。然后，通过 pip 安装 FastAPI-SQLAlchemy：

pip install fastapi-sqlalchemy

示例代码：创建基本应用

接下来，我们将展示一个简单的应用实例，该应用能够添加和检索用户信息。

初始化 SQLAlchemy 和 FastAPI

from fastapi import FastAPI
from fastapi_sqlalchemy import DBSessionMiddleware, SQLAlchemy
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

# 初始化 SQLAlchemy
Base = declarative_base()
db = SQLAlchemy(url="sqlite:///example.db")

class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    name = Column(String)
    email = Column(String)

    def __repr__(self):
        return f"User(id={self.id}, name='{self.name}', email='{self.email}')"

app = FastAPI()

# 添加中间件以管理数据库会话
app.add_middleware(DBSessionMiddleware, db_url="sqlite:///example.db")

创建路由处理用户数据

@app.get("/users")
async def get_users():
    # 获取所有用户
    return db.session.query(User).all()

@app.post("/add_user")
async def add_user(name: str, email: str):
    # 创建新用户并保存到数据库
    new_user = User(name=name, email=email)
    db.session.add(new_user)
    db.session.commit()
    return {"message": "User created successfully"}