SQLAdmin 开源项目教程
sqladminSQLAlchemy Admin for FastAPI and Starlette项目地址:https://gitcode.com/gh_mirrors/sq/sqladmin
项目介绍
SQLAdmin 是一个灵活的 Admin 接口,专为 SQLAlchemy 模型设计。它支持 SQLAlchemy 的同步/异步引擎,并与 Starlette 和 FastAPI 框架集成。SQLAdmin 使用 WTForms 进行表单构建,并支持 SQLModel。其用户界面基于 Tabler。
项目快速启动
安装
首先,使用 pip 安装 SQLAdmin:
pip install sqladmin
快速启动示例
以下是一个简单的 FastAPI 应用示例,展示了如何使用 SQLAdmin:
from fastapi import FastAPI
from sqladmin import Admin, ModelView
from sqlalchemy import Column, Integer, String, create_engine
from sqlalchemy.orm import declarative_base
Base = declarative_base()
engine = create_engine("sqlite:///example.db", connect_args={"check_same_thread": False})
class User(Base):
__tablename__ = "users"
id = Column(Integer, primary_key=True)
name = Column(String)
Base.metadata.create_all(engine)
app = FastAPI()
admin = Admin(app, engine)
class UserAdmin(ModelView, model=User):
column_list = [User.id, User.name]
admin.add_view(UserAdmin)
运行此代码后,访问 /admin
路径即可看到 SQLAdmin 的管理界面。
应用案例和最佳实践
应用案例
SQLAdmin 可以用于任何需要数据库管理界面的 FastAPI 或 Starlette 应用。例如,一个电商网站的后台管理系统可以使用 SQLAdmin 来管理用户、商品和订单数据。
最佳实践
- 权限控制:确保只有授权用户可以访问管理界面。
- 数据验证:使用 WTForms 进行表单数据验证,确保数据完整性。
- 性能优化:对于大型数据集,考虑使用分页和索引优化查询性能。
典型生态项目
SQLAdmin 与以下项目紧密集成:
- FastAPI:一个现代、快速(高性能)的 Web 框架,用于构建 API,基于 Python 3.7+ 标准。
- Starlette:一个轻量级的 ASGI 框架/工具包,是构建高性能异步服务的理想选择。
- SQLAlchemy:Python SQL 工具包和对象关系映射器,提供了 SQL 工具和从 Python 概念到数据库概念的映射。
- Tabler:一个免费的、开源的、响应式的 HTML 仪表板 UI 套件,基于 Bootstrap 4。
通过这些集成,SQLAdmin 提供了一个强大的、易于扩展的数据库管理解决方案。
sqladminSQLAlchemy Admin for FastAPI and Starlette项目地址:https://gitcode.com/gh_mirrors/sq/sqladmin