logo

如果你喜欢这个项目,给个 ⭐️ 支持一下吧!

Gitee Stars GitHub Stars License

简体中文 | English

📘 项目介绍

🎯 核心优势

🍪 演示环境

🔗 源码仓库

📦 工程结构概览

FastapiAdmin
├─ backend # 后端工程 (FastAPI + Python)
├─ frontend # Web前端工程 (Vue3 + Element Plus)
├─ devops # 部署配置
├─ docker-compose.yaml # Docker编排文件
├─ deploy.sh # 一键部署脚本
├─ LICENSE # 开源协议
|─ README.en.md # 英文文档
└─ README.md # 中文文档

🛠️ 技术栈概览

📌 内置功能模块

🔧 模块展示

web 端

移动端

🚀 快速开始

环境要求

获取代码

# 克隆代码到本地
git clone https://gitee.com/fastapiadmin/FastapiAdmin.git
# 或者
git clone https://github.com/fastapiadmin/FastapiAdmin.git

后端启动

使用 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 部署

# 复制部署脚本到服务器并赋予执行权限
chmod +x deploy.sh
# 执行一键部署
./deploy.sh or ./deploy.sh --start
# 查看容器日志
./deploy.sh --logs
# 停止服务
./deploy.sh --stop

🛠️ 二开教程

后端开发

插件化架构特性

插件目录结构

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 # 插件初始化文件

自动路由注册机制

二次开发步骤

控制器示例

# 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)

开发规范

注意事项

前端部分

代码生成器使用

生成步骤

生成文件结构

# 后端文件
backend/app/plugin/module_yourmodule/
└── yourfeature/
 ├── controller.py # 控制器文件
 ├── model.py # 数据模型文件
 ├── schema.py # 数据验证文件
 ├── service.py # 业务逻辑文件
 └── crud.py # 数据访问文件
# 前端文件
frontend/src/
├── api/module_yourmodule/
│ └── yourfeature.ts # API调用文件
└── views/module_yourmodule/
 └── yourfeature/
 └── index.vue # 页面组件

生成代码示例

# 生成的控制器代码示例
from fastapi import APIRouter, Depends
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
from .schema import (
 YourFeatureCreateSchema,
 YourFeatureUpdateSchema,
 YourFeatureQueryParam
)
YourFeatureRouter = APIRouter(
 route_class=OperationLogRoute, 
 prefix="/yourfeature", 
 tags=["你的功能模块"]
)
@YourFeatureRouter.get("/detail/{id}")
async def get_detail(
 id: int, 
 auth: AuthSchema = Depends(AuthPermission(["module_yourmodule:yourfeature:detail"]))
) -> JSONResponse:
 result = await YourFeatureService.detail_service(id=id, auth=auth)
 return SuccessResponse(data=result)

开发工具

开发流程

开发注意事项

常见问题

Q:如何添加新功能模块?

Q:如何配置数据库?

Q:如何配置Redis?

Q:如何生成数据库迁移文件?

Q:如何应用数据库迁移?

Q:如何启动开发服务器?

Q:如何构建前端生产版本?

Q:如何部署到生产环境?

i️ 帮助

👥 贡献者

🙏 特别鸣谢

🎨 社区交流

❤️ 支持项目