FastAPI Admin

基于 FastAPI 的企业级后台管理系统。

本项目后端业务逻辑借鉴自芋道 ruoyi-vue-pro 开源项目，感谢芋道团队的开源贡献。

前端项目

项目	地址
Vben Admin	https://github.com/XIE7654/fastapi-vben.git
Element Plus	https://github.com/XIE7654/fastapi-ele.git

在线演示

前端	地址
Element Plus	https://fastele.chenzida.com/
Vben Admin	https://fastvben.chenzida.com/

演示账号：admin / admin123

技术栈

Java技术	FastAPI技术	版本
Spring Boot 2.7	FastAPI	0.115+
Spring Security	python-jose + passlib	3.3.0 / 1.7.4
MyBatis-Plus	SQLAlchemy	2.0.36+
Druid	aiomysql	0.2.0
Redisson	redis-py	5.2.0
Knife4j	内置Swagger UI	-
Lombok	Pydantic	2.10+
Spring Task	APScheduler	3.10+
Lock4j	自定义Redis锁	-

项目结构

fastapi-admin/
├── app/
│   ├── core/                    # 核心组件
│   │   ├── database.py          # 数据库连接
│   │   ├── redis.py             # Redis连接
│   │   ├── security.py          # JWT认证
│   │   ├── tenant.py            # 多租户支持
│   │   ├── lock.py              # 分布式锁
│   │   ├── scheduler.py         # 定时任务
│   │   ├── metrics.py           # Prometheus监控
│   │   ├── exceptions.py        # 异常定义
│   │   └── dependencies.py      # FastAPI依赖
│   ├── middleware/              # 中间件
│   │   ├── tenant.py            # 租户中间件
│   │   ├── logging.py           # 日志中间件
│   │   ├── auth.py              # 认证中间件
│   │   └── demo.py              # 演示环境中间件
│   ├── module/system/           # 系统模块
│   │   ├── controller/          # API控制器
│   │   ├── service/             # 业务服务
│   │   ├── model/               # 数据库模型
│   │   ├── schema/              # Pydantic模型
│   │   └── repository/          # 数据访问
│   ├── common/                  # 公共组件
│   │   ├── response.py          # 统一响应
│   │   ├── pagination.py        # 分页处理
│   │   ├── excel.py             # Excel导出
│   │   ├── schema.py            # 基础Schema
│   │   └── utils.py             # 工具函数
│   └── extensions/              # 扩展功能
│       ├── captcha.py           # 验证码
│       └── storage.py           # 文件存储
├── migrations/                  # Alembic迁移
│   ├── env.py                   # 迁移配置
│   ├── alembic.ini              # Alembic配置
│   └── versions/                # 迁移版本文件
├── scripts/                     # 脚本文件
│   ├── fastadmin.sql            # 数据库初始化SQL
│   ├── init_db.py               # 数据库初始化脚本
│   └── scheduled_tasks.py       # 定时任务示例
├── requirements.txt             # 依赖文件
├── pyproject.toml               # 项目配置
├── Dockerfile                   # Docker配置
├── docker-compose.yml           # 容器编排
└── README.md                    # 项目文档

功能模块

基础架构

系统模块

模块	功能	状态
用户管理	CRUD、密码修改、重置密码、头像上传	✅
角色管理	CRUD、权限分配、数据权限	✅
菜单管理	CRUD、菜单树、权限标识	✅
部门管理	CRUD、部门树、层级查询	✅
岗位管理	CRUD	✅
字典管理	类型管理、数据管理、缓存	✅
参数配置	CRUD、缓存支持	✅
操作日志	记录API操作、装饰器支持	✅
登录日志	登录/登出记录、UA解析	✅
在线用户	Redis存储、踢出用户	✅
通知公告	CRUD	✅
地区管理	树形结构、懒加载	✅

租户模块

功能	状态	说明
租户管理	✅	CRUD、域名绑定
租户套餐	✅	CRUD、套餐权限

短信模块

功能	状态	说明
短信渠道	✅	CRUD、多渠道支持
短信模板	✅	CRUD、模板管理
短信日志	✅	查询、导出

邮件模块

功能	状态	说明
邮箱账号	✅	CRUD
邮件模板	✅	CRUD
邮件日志	✅	查询、导出

站内信模块

功能	状态	说明
站内信模板	✅	CRUD
站内信消息	✅	查询、已读标记

OAuth2 & 社交登录

功能	状态	说明
OAuth2客户端	✅	CRUD
OAuth2令牌	✅	查询、删除
社交客户端	✅	CRUD
社交用户	✅	查询、解绑

权限管理

功能	状态	说明
用户权限	✅	分配角色权限
角色权限	✅	分配菜单权限
数据权限	✅	部门层级权限过滤

快速开始

1. 环境准备

# 克隆项目
git clone https://github.com/XIE7654/fastapi-admin.git
cd fastapi-admin

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # Linux/Mac
# 或
venv\Scripts\activate  # Windows

# 安装依赖
pip install -r requirements.txt

2. 配置

# 复制配置文件
cp .env.example .env

# 编辑配置
vim .env

主要配置项：

# 数据库配置
DB_HOST=127.0.0.1
DB_PORT=3306
DB_USER=root
DB_PASSWORD=your_password
DB_NAME=fastadmin

# Redis配置
REDIS_HOST=127.0.0.1
REDIS_PORT=6379

# JWT配置
JWT_SECRET_KEY=your-secret-key

# 演示环境配置（可选）
DEMO_MODE=false  # 设为 true 启用演示模式，禁止写操作

3. 初始化数据库

方式一：使用 SQL 文件（推荐）

# 创建数据库
mysql -u root -p -e "CREATE DATABASE \`fastadmin\` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"

# 导入表结构和初始数据
mysql -u root -p fastadmin < scripts/fastadmin.sql

4. 启动服务

开发模式

# 方式一
python -m app.main

# 方式二（支持热重载）
uvicorn app.main:app --reload --port 28000

生产模式

uvicorn app.main:app --host 0.0.0.0 --port 28000 --workers 4

5. Docker 部署

docker-compose up -d

API 文档

启动后访问：

Swagger UI: http://localhost:8000/admin-api/docs
ReDoc: http://localhost:8000/admin-api/redoc
Prometheus: http://localhost:8000/metrics

演示环境

在 .env 中设置 DEMO_MODE=true 启用演示模式：

只允许查询操作（GET 请求）
禁止修改、删除等写操作（POST/PUT/DELETE/PATCH）
登录、登出接口不受限制

核心功能示例

多租户使用

from app.core.tenant import get_tenant_id, set_tenant

# 设置租户
set_tenant(1)

# 获取当前租户
tenant_id = get_tenant_id()

权限控制

from app.core.dependencies import check_permission

@router.get("/users", dependencies=[Depends(check_permission("system:user:list"))])
async def list_users():
    ...

分布式锁

from app.core.lock import distributed_lock

async with distributed_lock("user:1:update", timeout=30):
    # 执行需要加锁的操作
    ...

定时任务

from app.core.scheduler import scheduled

@scheduled(cron="0 9 * * *")
async def daily_report():
    # 每天9点执行
    ...

数据权限

from app.module.system.service import get_data_permission_filter

# 获取带权限过滤的查询
query = await get_data_permission_filter(db, user_id, User)
result = await db.execute(query.where(User.status == 0))

开发指南

创建新模块

# app/module/new_module/
├── controller/    # API控制器
├── service/       # 业务服务
├── repository/    # 数据访问
├── model/         # 数据库模型
└── schema/        # Pydantic模型

数据库迁移

# 生成迁移文件
alembic revision --autogenerate -m "描述"

# 执行迁移
alembic upgrade head

# 回滚迁移
alembic downgrade -1

运行测试

pytest

License

MIT

Name		Name	Last commit message	Last commit date
Latest commit History 63 Commits
app		app
migrations		migrations
scripts		scripts
tests		tests
.env.example		.env.example
.gitignore		.gitignore
Dockerfile		Dockerfile
README.md		README.md
docker-compose.yml		docker-compose.yml
elk.md		elk.md
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt

Folders and files

Latest commit

History

Repository files navigation

FastAPI Admin

前端项目

在线演示

技术栈

项目结构

功能模块

基础架构

系统模块

租户模块

短信模块

邮件模块

站内信模块

OAuth2 & 社交登录

权限管理

快速开始

1. 环境准备

2. 配置

3. 初始化数据库

4. 启动服务

5. Docker 部署

API 文档

演示环境

核心功能示例

多租户使用

权限控制

分布式锁

定时任务

数据权限

开发指南

创建新模块

数据库迁移

运行测试

License

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages