FastAPI Utilities 使用教程
fastapi-utilsReusable utilities for FastAPI项目地址:https://gitcode.com/gh_mirrors/fa/fastapi-utils
项目介绍
FastAPI Utilities 是一个为 FastAPI 框架提供可重用工具和实用程序的库。它旨在简化 FastAPI 应用程序的开发过程,提供诸如定时任务、重复任务、会话管理等功能。该项目由社区维护,源代码托管在 GitHub 上,地址为:https://github.com/dmontagu/fastapi-utils。
项目快速启动
安装
首先,你需要安装 FastAPI 和 FastAPI Utilities 库。你可以使用 pip 进行安装:
pip install fastapi fastapi-utils
创建一个简单的 FastAPI 应用
以下是一个简单的 FastAPI 应用程序示例,展示了如何使用 FastAPI Utilities 中的 repeat_every
装饰器来创建一个定时任务:
from fastapi import FastAPI
from fastapi_utils.tasks import repeat_every
app = FastAPI()
@app.on_event("startup")
@repeat_every(seconds=5, raise_exceptions=True)
async def startup_task():
print("This task runs every 5 seconds")
@app.get("/")
async def read_root():
return {"message": "Hello World"}
运行应用
使用以下命令启动你的 FastAPI 应用:
uvicorn main:app --reload
访问 http://127.0.0.1:8000/
,你应该能看到 "Hello World" 的消息,并且每 5 秒钟会在控制台看到 "This task runs every 5 seconds" 的输出。
应用案例和最佳实践
定时任务
FastAPI Utilities 提供了 repeat_every
装饰器,可以方便地创建定时任务。以下是一个更复杂的示例,展示了如何在一个实际应用中使用定时任务来更新缓存:
from fastapi import FastAPI
from fastapi_utils.tasks import repeat_every
import asyncio
app = FastAPI()
cache = {}
@app.on_event("startup")
@repeat_every(seconds=60, raise_exceptions=True)
async def update_cache():
global cache
# 模拟从数据库获取数据
cache = {"data": "updated at " + str(datetime.now())}
print("Cache updated")
@app.get("/cache")
async def get_cache():
return cache
会话管理
FastAPI Utilities 还提供了会话管理工具,可以简化数据库会话的管理。以下是一个使用 FastAPISessionMaker
的示例:
from fastapi import FastAPI
from fastapi_utils.session import FastAPISessionMaker
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
DATABASE_URL = "sqlite:///./test.db"
engine = create_engine(DATABASE_URL)
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
app = FastAPI()
session_maker = FastAPISessionMaker(DATABASE_URL)
@app.get("/items/")
async def read_items():
with session_maker.context_session() as session:
# 使用 session 进行数据库操作
return {"message": "Items read successfully"}
典型生态项目
FastAPI Utilities 是 FastAPI 生态系统中的一个重要组成部分。以下是一些与 FastAPI 相关的其他项目和库:
- FastAPI: 一个现代、快速(高性能)的 web 框架,用于构建 APIs,基于 Starlette 和 Pydantic。
- Pydantic: 一个数据验证和设置管理的库,FastAPI 的核心依赖之一。
- SQLAlchemy: 一个 SQL 工具包和对象关系映射(ORM)库,常用于与 FastAPI 结合进行数据库操作。
- Alembic: 一个轻量级的数据库迁移工具,由 SQLAlchemy 的作者开发,常用于管理数据库 schema 的变更。
这些项目和库共同构成了一个强大的生态系统,支持开发者构建高效、可维护的 FastAPI 应用程序。
fastapi-utilsReusable utilities for FastAPI项目地址:https://gitcode.com/gh_mirrors/fa/fastapi-utils