FastAPI-Amis-Admin 安装和配置指南
1. 项目基础介绍和主要编程语言
项目基础介绍
FastAPI-Amis-Admin 是一个高性能、高效且易于扩展的 FastAPI 管理框架。它受到 Django-admin 的启发,并拥有与 Django-admin 一样强大的功能。FastAPI-Amis-Admin 旨在快速生成 Web 应用程序的可视化仪表板,并根据 Apache 2.0 协议免费开源。
主要编程语言
FastAPI-Amis-Admin 主要使用 Python 3.7+ 进行开发,基于标准的 Python 类型提示。
2. 项目使用的关键技术和框架
关键技术和框架
- FastAPI: 用于构建 Web 应用程序的高性能框架。
- SQLModel: 用于 ORM 模型映射,完美结合了 SQLAlchemy 和 Pydantic 的特性。
- Amis: 用于管理页面展示的前端框架。
3. 项目安装和配置的准备工作和详细安装步骤
准备工作
在开始安装之前,请确保您的系统上已经安装了以下软件:
- Python 3.7 或更高版本
- pip(Python 的包管理工具)
详细安装步骤
步骤 1: 创建虚拟环境(可选但推荐)
为了隔离项目依赖,建议创建一个虚拟环境。
python3 -m venv fastapi-amis-admin-env
source fastapi-amis-admin-env/bin/activate # 在 Windows 上使用 `fastapi-amis-admin-env\Scripts\activate`
步骤 2: 安装 FastAPI-Amis-Admin
使用 pip 安装 FastAPI-Amis-Admin。
pip install fastapi_amis_admin
如果您使用 SQLModel 来创建模型,可以安装包含 SQLModel 的依赖库:
pip install fastapi_amis_admin[sqlmodel]
步骤 3: 创建 FastAPI 应用程序
创建一个新的 Python 文件(例如 main.py
),并添加以下代码来创建一个简单的 FastAPI 应用程序。
from fastapi import FastAPI
from fastapi_amis_admin.admin.settings import Settings
from fastapi_amis_admin.admin.site import AdminSite
# 创建 FastAPI 应用程序
app = FastAPI()
# 创建 AdminSite 实例
site = AdminSite(settings=Settings(database_url_async='sqlite+aiosqlite:///amisadmin.db'))
# 挂载 AdminSite 实例
site.mount_app(app)
if __name__ == '__main__':
import uvicorn
uvicorn.run(app)
步骤 4: 运行应用程序
在终端中运行以下命令来启动 FastAPI 应用程序。
uvicorn main:app --reload
步骤 5: 访问管理界面
打开浏览器并访问 http://127.0.0.1:8000/admin
,您将看到 FastAPI-Amis-Admin 的管理界面。
配置指南
FastAPI-Amis-Admin 的配置主要通过 Settings
类进行。您可以在创建 AdminSite
实例时传递不同的配置参数来定制您的应用程序。
例如,配置数据库连接:
site = AdminSite(settings=Settings(database_url_async='sqlite+aiosqlite:///amisadmin.db'))
您还可以根据需要配置其他参数,如日志、认证等。
总结
通过以上步骤,您已经成功安装并配置了 FastAPI-Amis-Admin 项目。现在您可以开始使用这个强大的管理框架来构建您的 Web 应用程序了。