FastCRUD 安装与配置指南

1. 项目基础介绍

FastCRUD 是一个为 FastAPI 设计的 Python 包，它提供了强大的异步 CRUD 操作和灵活的端点创建工具。通过高级特性如自动检测连接条件、动态排序以及偏移量和游标分页，FastCRUD 能有效简化数据库交互过程。

主要编程语言：Python

2. 关键技术和框架

• FastAPI: 用于构建 API 的现代、快速（高性能）的 Web 框架。
• SQLAlchemy: 强大的 SQL 工具包和对象关系映射（ORM）系统。
• Pydantic: 用于数据验证和设置的 Python 库。
• SQLAlchemy-Utils: 为 SQLAlchemy 提供附加实用程序的库（可选）。

3. 安装和配置

准备工作

在开始安装 FastCRUD 前，请确保您的环境中已安装以下依赖项：

• Python 3.9 或更高版本
• FastAPI
• SQLAlchemy 版本 2.0.21 或更高
• Pydantic 版本 2.4.1 或更高
• SQLAlchemy-Utils（推荐）

安装步骤

1. 安装 FastCRUD

   使用 pip 安装 FastCRUD：

   pip install fastcrud
   

   或者，如果您使用 poetry 作为包管理工具：

   poetry add fastcrud
   

2. 设置数据库

   在使用 FastCRUD 之前，您需要设置数据库连接。以下是一个使用 SQLAlchemy 的异步数据库连接示例：

   from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
   from sqlalchemy.orm import sessionmaker
   
   # 数据库 URL，根据您的数据库类型进行修改
   DATABASE_URL = "sqlite+aiosqlite:///./test.db"
   
   # 创建异步数据库引擎
   engine = create_async_engine(DATABASE_URL, echo=True)
   
   # 创建异步会话工厂
   async_session = sessionmaker(engine, class_=AsyncSession, expire_on_commit=False)
   

3. 定义模型和模式

   在使用 FastCRUD 之前，您需要定义数据库模型和 Pydantic 模式。例如：

   # models.py
   from sqlalchemy import Column, Integer, String
   from sqlalchemy.orm import DeclarativeBase
   
   Base = DeclarativeBase()
   
   class Item(Base):
       __tablename__ = 'items'
       id = Column(Integer, primary_key=True)
       name = Column(String)
       description = Column(String)
   
   # schemas.py
   from pydantic import BaseModel
   
   class ItemCreateSchema(BaseModel):
       name: str
       description: str
   
   class ItemUpdateSchema(BaseModel):
       name: str
       description: str
   

4. 创建 FastAPI 应用程序并配置 FastCRUD

   使用 FastCRUD 提供的 crud_router 快速创建 CRUD 端点，或者直接在您的 FastAPI 端点函数中使用 FastCRUD：

   # main.py
   from fastapi import FastAPI
   from fastcrud import FastCRUD, crud_router
   from yourapp.models import Base, Item
   from yourapp.schemas import ItemCreateSchema, ItemUpdateSchema
   
   # FastAPI 应用程序
   app = FastAPI()
   
   # CRUD 路由设置
   item_router = crud_router(
       session=get_session,
       model=Item,
       create_schema=ItemCreateSchema,
       update_schema=ItemUpdateSchema,
       path="/items",
       tags=["Items"]
   )
   
   app.include_router(item_router)
   

5. 运行应用程序

   使用 FastAPI 提供的运行命令来启动您的应用程序：

   uvicorn main:app --reload
   

   现在，您的 FastAPI 应用程序应该已经配置好并运行，具备 FastCRUD 的 CRUD 功能。

以上就是 FastCRUD 的详细安装和配置指南。按照这些步骤操作，您应该能够成功集成 FastCRUD 到您的项目中。