FastapiAdmin
FastAdmin 是一套完全开源的快速开发平台，提供免费使用。它结合了现代、高性能的技术栈，后端采用Fastapi + SQLAlchemy，前端采用基于 vue3 + typescript + vite + pinia + Element-Plus。旨在帮助开发者快速搭建高质量的中后台系统。
Install / Use
/learn @fastapiadmin/FastapiAdminREADME
简体中文 | English
</div>📘 项目介绍
FastApiAdmin 是一套 完全开源、高度模块化、技术先进的现代化快速开发平台，旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 前后端分离架构，融合 Python 后端框架 FastAPI 和前端主流框架 Vue3 实现多端统一开发，提供了一站式开箱即用的开发体验。
设计初心: 以模块化、松耦合为核心，追求丰富的功能模块、简洁易用的接口、详尽的开发文档和便捷的维护方式。通过统一框架和组件，降低技术选型成本，遵循开发规范和设计模式，构建强大的代码分层模型，搭配完善的本地中文化支持，专为团队和企业开发场景量身定制。
🎯 核心优势
| 优势 | 描述 | | ---- | ---- | | 🔥 现代化技术栈 | 基于 FastAPI + Vue3 + TypeScript 等前沿技术构建 | | ⚡ 高性能异步 | 利用 FastAPI 异步特性和 Redis 缓存优化响应速度 | | 🔐 安全可靠 | JWT + OAuth2 认证机制，RBAC 权限控制模型 | | 🧱 模块化设计 | 高度解耦的系统架构，便于扩展和维护 | | 🌐 全栈支持 | Web端 + 移动端(H5) + 后端一体化解决方案 | | 🚀 快速部署 | Docker 一键部署，支持生产环境快速上线 | | 📖 完善文档 | 详细的开发文档和教程，降低学习成本 | | 🤖 智能体框架 | 基于Langchain和Langgraph的开发智能体 |
🍪 演示环境
- 💻 网页端：https://service.fastapiadmin.com/web
- 📱 移动端：https://service.fastapiadmin.com/app
- 👤 登录账号：
admin密码：123456
🔗 源码仓库
| 平台 | 仓库地址 | |------|----------| | GitHub | FastapiAdmin主工程 | FastDocs官网 | FastApp移动端 | | Gitee | FastapiAdmin主工程 | FastDocs官网 | FastApp移动端 |
📦 工程结构概览
FastapiAdmin
├─ backend # 后端工程 (FastAPI + Python)
├─ frontend # Web前端工程 (Vue3 + Element Plus)
├─ devops # 部署配置
├─ docker-compose.yaml # Docker编排文件
├─ deploy.sh # 一键部署脚本
├─ LICENSE # 开源协议
|─ README.en.md # 英文文档
└─ README.md # 中文文档
🛠️ 技术栈概览
| 类型 | 技术选型 | 描述 | |------|----------|------| | 后端框架 | FastAPI / Uvicorn / Pydantic 2.0 / Alembic | 现代、高性能的异步框架，强制类型约束，数据迁移 | | ORM | SQLAlchemy 2.0 | 强大的 ORM 库 | | 定时任务 | APScheduler | 轻松实现定时任务 | | 权限认证 | PyJWT | 实现 JWT 认证 | | 前端框架 | Vue3 / Vite5 / Pinia / TypeScript | 快速开发 Vue3 应用 | | Web UI | ElementPlus | 企业级 UI 组件库 | | 移动端 | UniApp / Wot Design Uni | 跨端移动应用框架 | | 数据库 | MySQL / PostgreSQL / Sqlite | 关系型和文档型数据库支持 | | 缓存 | Redis | 高性能缓存数据库 | | 文档 | Swagger / Redoc | 自动生成 API 文档 | | 部署 | Docker / Nginx / Docker Compose | 容器化部署方案 | | 智能体框架 | Langchain / Langgraph | 基于Langchain和Langgraph的智能体框架 |
📌 内置功能模块
| 模块 | 功能 | 描述 | |------|------|------| | 📊 仪表盘 | 工作台、分析页 | 系统概览和数据分析 | | ⚙️ 系统管理 | 用户、角色、菜单、部门、岗位、字典、配置、公告 | 核心系统管理功能 | | 👀 监控管理 | 在线用户、服务器监控、缓存监控 | 系统运行状态监控 | | 📋 任务管理 | 定时任务 | 异步任务调度管理 | | 📝 日志管理 | 操作日志 | 用户行为审计 | | 🧰 开发工具 | 代码生成、表单构建、接口文档 | 提升开发效率的工具 | | 📁 文件管理 | 文件存储 | 统一文件管理 |
🔧 模块展示
web 端
| 模块名 <div style="width:60px"/> | 截图 |
| ----- | --- |
| 仪表盘 | 
|
| 代码生成 | 
|
| 智能助手 | 
|
移动端
| 登录 <div style="width:60px"/> | 首页 <div style="width:60px"/> | 个人中心 <div style="width:60px"/> |
|----------|----------|----------|
| 
| 
| 
|
🚀 快速开始
环境要求
| 类型 | 技术栈 | 版本 | |------|--------|------| | 后端 | Python | 3.12 ≥ 3.10 | | 后端 | FastAPI | 0.109+ | | 前端 | Node.js | ≥ 20.0 | | 前端 | Vue3 | 3.3+ | | 数据库 | MySQL/PostgreSQL | 8.0+/17+ | | 缓存 | Redis | 7.0+ |
获取代码
# 克隆代码到本地
git clone https://gitee.com/fastapiadmin/FastapiAdmin.git
# 或者
git clone https://github.com/fastapiadmin/FastapiAdmin.git
后端注意：克隆下的代码需要修改
backend/env目录下的.env.dev.example文件为.env.dev，修改backend/env目录下的.env.prod.example文件为.env.prod，然后根据实际情况修改数据库连接信息、Redis连接信息等。
前端注意：克隆下的代码需要修改
frontend目录下的.env.development.example文件为.env.development，修改frontend目录下的.env.production.example文件为.env.production，然后根据实际情况修改接口地址等。
后端启动
使用 uv 管理项目（推荐）
# 进入后端工程目录
cd backend
# 使用 uv 安装依赖
uv add -r requirements.txt
# 启动后端服务：启动之前保证mysql中创建好了数据库、redis服务
uv run main.py run
# 或指定环境
uv run main.py run --env=dev or --env=prod
使用传统 pip 方式
# 进入后端工程目录
cd backend
# 安装依赖
pip3 install -r requirements.txt
# 启动后端服务：启动之前保证mysql中创建好了数据库、redis服务
python main.py run
# 或指定环境
python main.py run --env=dev or --env=prod
前端启动
# 进入前端工程目录
cd frontend
# 安装依赖
pnpm install
# 启动开发服务器
pnpm run dev
# 构建生产版本
pnpm run build
🐳 Docker 部署
方式一：脚本放在项目内执行（推荐）
# 1. 克隆代码到服务器
git clone https://gitee.com/fastapiadmin/FastapiAdmin.git
cd FastapiAdmin
# 2. 赋予执行权限并部署
chmod +x deploy.sh
./deploy.sh
# 查看容器日志
./deploy.sh logs
# 停止服务
./deploy.sh stop
# 重启服务
./deploy.sh restart
# 更新代码并重启（不重新构建镜像，适合后端代码热更新）
./deploy.sh update
方式二：脚本放在项目外执行
# 1. 将部署脚本复制到服务器
cp deploy.sh /home/
cd /home
chmod +x deploy.sh
# 2. 执行一键部署（会自动克隆项目）
./deploy.sh
# 查看容器日志
./deploy.sh logs
# 停止服务
./deploy.sh stop
# 重启服务
./deploy.sh restart
# 更新代码并重启（不重新构建镜像，适合后端代码热更新）
./deploy.sh update
注意：
- 首次部署时会自动拉取代码并构建镜像
- 前端使用本地构建的 dist 目录，如需更新前端请先本地构建并提交到仓库
- 确保
devops/nginx/ssl/目录包含 SSL 证书文件（如使用 HTTPS）
🛠️ 二开教程
后端开发
项目采用插件化架构设计，二次开发建议在 backend/app/plugin 目录下进行，系统会自动发现并注册所有符合规范的路由，便于模块管理和升级维护。
插件化架构特性
- 自动路由发现：系统会自动扫描
backend/app/plugin/目录下所有controller.py文件 - 自动路由注册：所有路由会被自动注册到对应的前缀路径 (module_xxx -> /xxx)
- 模块化管理：按功能模块组织代码，便于维护和扩展
- 支持多层级嵌套：支持模块内部多层级嵌套结构
插件目录结构
backend/app/plugin/
├── module_application/ # 应用模块（自动映射为 /application）
│ └── ai/ # AI子模块
│ ├── controller.py # 控制器文件
│ ├── model.py # 数据模型文件
│ ├── schema.py # 数据验证文件
│ ├── service.py # 业务逻辑文件
│ └── crud.py # 数据访问文件
├── module_example/ # 示例模块（自动映射为 /example）
│ └── demo/ # 子模块
│ ├── controller.py # 控制器文件
│ ├── model.py # 数据模型文件
│ ├── schema.py # 数据验证文件
│ ├── service.py # 业务逻辑文件
│ └── crud.py # 数据访问文件
├── module_generator/ # 代码生成模块（自动映射为 /generator）
└── init_app.py # 插件初始化文件
自动路由注册机制
系统会自动发现并注册所有符合以下条件的路由：
- 控制器文件必须命名为
controller.py - 路由会自动映射：
module_xxx->/xxx - 支持多个
APIRouter实例 - 自动处理路由去重
二次开发步骤
- 创建插件模块：在
backend/app/plugin/目录下创建新的模块目录，如module_yourfeature - 编写数据模型：在
model.py中定义数据库模型 - 编写数据验证：在
schema.py中定义数据验证模型 - 编写数据访问层：在
crud.py中编写数据库操作逻辑 - 编写业务逻辑层：在
service.py中编写业务逻辑 - 编写控制器：在
controller.py中定义路由和处理函数 - 自动注册：系统会自动扫描并注册所有路由，无需手动配置
控制器示例
# backend/app/plugin/module_yourfeature/yourcontroller/controller.py
from fastapi import APIRouter, Depends, Path
from fastapi.responses import JSONResponse
from app.common.response import SuccessResponse
from app.core.router_class import OperationLogRoute
from app.core.dependencies import AuthPermission
from app.api.v1.module_system.auth.schema import AuthSchema
from .service import YourFeatureService
# 创建路由实例
YourFeatureRouter = APIRouter(
route_class=OperationLogRoute,
prefix="/yourcontroller",
tags=["你的功能模块"]
)
@YourFeatureRouter.get("/detail/{id}", summary="获取详情")
async def get_detail(
id: int = Path(..., description="功能ID"),
auth: AuthSchema = Depends(AuthPermission(["module_yourfeature:yourcontroller:detail"]))
) -> JSONResponse:
result = await YourFeatureService.detail_service(id=id, auth=auth)
return SuccessResponse(data=result)
@YourFeatureRouter.get("/list", summary="获取列表")
async def get_list(
auth: AuthSchema = Depends(AuthPermission(["module_yourfeature:yourcontroller:list"]))
) -> JSONResponse:
result = await YourFeatureService.list_service(auth=auth)
return SuccessResponse(data=result)
开发规范
- 命名规范：模块名采用
module_xxx格式，控制器名采用驼峰命名法 - 权限控制：所有API接口必须添加权限控制装饰器
- 日志记录：使用
OperationLogRoute类自动记录操作日志 - 返回格式：统一使用
SuccessResponse或ErrorResponse返回响应 - 代码注释：为所有API接口添加详细的文档字符串
注意事项
- 插件模块名必须以
module_开头 - 控制器文件必须命名为
controller.py - 路由会自动映射到对应的前缀路径
- 无需手动注册路由，系统会自动发现并注册
前端部分
- 配置前端API：在
frontend/src/api/目录下创建对应的API文件 - 编写页面组件：在
frontend/src/views/目录下创建页面组件 - 注册路由：在
frontend/src/router/index.ts中注册路由
代码生成器使用
项目内置代码生成器，可以根据数据库表结构自动生成前后端代码，大幅提升开发效率。
生成步骤
- 登录系统：使用
Related Skills
feishu-drive
337.1k|
things-mac
337.1kManage Things 3 via the `things` CLI on macOS (add/update projects+todos via URL scheme; read/search/list from the local Things database)
clawhub
337.1kUse the ClawHub CLI to search, install, update, and publish agent skills from clawhub.com
yu-ai-agent
1.9k编程导航 2025 年 AI 开发实战新项目，基于 Spring Boot 3 + Java 21 + Spring AI 构建 AI 恋爱大师应用和 ReAct 模式自主规划智能体YuManus，覆盖 AI 大模型接入、Spring AI 核心特性、Prompt 工程和优化、RAG 检索增强、向量数据库、Tool Calling 工具调用、MCP 模型上下文协议、AI Agent 开发（Manas Java 实现）、Cursor AI 工具等核心知识。用一套教程将程序员必知必会的 AI 技术一网打尽，帮你成为 AI 时代企业的香饽饽，给你的简历和求职大幅增加竞争力。
