mirror of https://github.com/fastapiadmin/FastapiAdmin.git synced 2026-09-20 20:39:55 +00:00

Files

T

zhangtao 846e9724ab docs: 更新项目文档结构并添加插件化架构说明

重构README文档结构，详细说明插件化架构设计和开发流程
添加自动路由注册机制和二次开发步骤
补充代码生成器使用说明和开发规范
更新英文版文档保持内容同步

2026-01-12 23:47:00 +08:00

22 KiB

Raw Blame History

FastApiAdmin ^v2.0.0

现代化全栈快速开发平台

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

简体中文 | English

📘 项目介绍

FastApiAdmin 是一套 完全开源、高度模块化、技术先进的现代化快速开发平台，旨在帮助开发者高效搭建高质量的企业级中后台系统。该项目采用 前后端分离架构，融合 Python 后端框架 FastAPI 和前端主流框架 Vue3 实现多端统一开发，提供了一站式开箱即用的开发体验。

设计初心: 以模块化、松耦合为核心，追求丰富的功能模块、简洁易用的接口、详尽的开发文档和便捷的维护方式。通过统一框架和组件，降低技术选型成本，遵循开发规范和设计模式，构建强大的代码分层模型，搭配完善的本地中文化支持，专为团队和企业开发场景量身定制。

🔗 源码仓库

平台	仓库地址
GitHub	FastapiAdmin主工程 \| FastDocs官网 \| FastApp移动端
Gitee	FastapiAdmin主工程 \| FastDocs官网 \| FastApp移动端

🎯 核心优势

优势	描述
🔥 现代化技术栈	基于 FastAPI + Vue3 + TypeScript 等前沿技术构建
⚡ 高性能异步	利用 FastAPI 异步特性和 Redis 缓存优化响应速度
🔐 安全可靠	JWT + OAuth2 认证机制，RBAC 权限控制模型
🧱 模块化设计	高度解耦的系统架构，便于扩展和维护
🌐 全栈支持	Web端 + 移动端(H5) + 后端一体化解决方案
🚀 快速部署	Docker 一键部署，支持生产环境快速上线
📖 完善文档	详细的开发文档和教程，降低学习成本

📦 工程结构概览

FastapiAdmin
├─ backend               # 后端工程 (FastAPI + Python)
├─ frontend              # Web前端工程 (Vue3 + Element Plus)
├─ fastapp               # 移动端工程 (UniApp + Wot Design Uni)
├─ fastdocs              # 官网文档工程 (VitePress)
├─ 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 / MongoDB	关系型和文档型数据库支持
缓存	Redis	高性能缓存数据库
文档	Swagger / Redoc	自动生成 API 文档
部署	Docker / Nginx / Docker Compose	容器化部署方案

📌 内置功能模块

模块	功能	描述
📊 仪表盘	工作台、分析页	系统概览和数据分析
⚙️ 系统管理	用户、角色、菜单、部门、岗位、字典、配置、公告	核心系统管理功能
👀 监控管理	在线用户、服务器监控、缓存监控	系统运行状态监控
📋 任务管理	定时任务	异步任务调度管理
📝 日志管理	操作日志	用户行为审计
🧰 开发工具	代码生成、表单构建、接口文档	提升开发效率的工具
📁 文件管理	文件存储	统一文件管理

🍪 演示环境

🌐 官网地址：https://service.fastapiadmin.com
💻 Web演示：https://service.fastapiadmin.com/web
📱 移动端：https://service.fastapiadmin.com/app
👤 登录账号：admin 密码：123456

🚀 快速开始

环境要求

类型	技术栈	版本
后端	Python	3.12 ≥ 3.10
后端	FastAPI	0.109+
前端	Node.js	≥ 20.0
前端	Vue3	3.3+
数据库	MySQL	8.0+
缓存	Redis	7.0+

获取代码

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

后端启动

# 进入后端工程目录
cd backend

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

# 启动后端服务：启动之前保证mysql中创建好了数据库、redis服务
python main.py run
# 或指定环境
python main.py run --env=dev

# 生成迁移文件
python main.py revision --env=dev
# 应用迁移
python main.py upgrade --env=dev

前端启动

# 进入前端工程目录
cd frontend

# 安装依赖
pnpm install

# 启动开发服务器
pnpm run dev

# 构建生产版本
pnpm run build

移动端启动

# 进入移动端工程目录
cd fastapp

# 安装依赖
pnpm install

# 启动H5开发服务器
pnpm run dev:h5

# 构建H5生产版本
pnpm run build:h5

文档启动

# 进入文档工程目录
cd fastdocs

# 安装依赖
pnpm install

# 启动文档开发服务器
pnpm run docs:dev

# 构建文档生产版本
pnpm run docs:build

访问地址

🏠 项目官网：http://localhost:5180
🖥️ Web端：http://localhost:5180/web
📱 移动端：http://localhost:5180/app

默认账号：

管理员：admin / 123456

🐳 Docker 部署

# 复制部署脚本到服务器并赋予执行权限
chmod +x deploy.sh

# 执行一键部署
./deploy.sh

# 常用 Docker 命令
# 查看运行中的容器
docker compose ps

# 查看容器日志
docker logs -f <容器名>

# 停止服务
docker compose down

🔧 模块展示

web 端

模块名	截图
登录
仪表盘
分析页
菜单管理
部门管理
岗位管理
角色管理
用户管理
日志管理
配置管理
在线用户
服务器监控
缓存监控
任务管理
字典管理
接口管理
系统主题
在线文档
系统锁屏
表单构建
代码生成
流程管理
文件管理
我的应用
配置中心
智能助手

移动端

模块	详情	模块	详情	模块	详情
登录		首页		我的
个人		设置		工作台

🛠️ 二开教程

后端开发

项目采用插件化架构设计，二次开发建议在 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 中注册路由

移动端部分

配置移动端API：在 fastapp/src/api/ 目录下创建对应的API文件
编写页面组件：在 fastapp/src/pages/ 目录下创建页面组件
注册路由：在 fastapp/src/router/index.ts 中注册路由

代码生成器使用

项目内置代码生成器，可以根据数据库表结构自动生成前后端代码，大幅提升开发效率。

生成步骤

登录系统：使用管理员账号登录系统
进入代码生成模块：在左侧菜单中点击"代码生成"
导入表结构：选择要生成代码的数据库表
配置生成参数：填写模块名称、功能名称等
生成代码：点击"生成代码"按钮
下载或写入：选择下载代码包或直接写入项目目录

生成文件结构

# 后端文件
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)

开发工具

代码生成器：自动生成前后端CRUD代码
API文档：自动生成Swagger/Redoc API文档
数据库迁移：支持Alembic数据库迁移
日志系统：内置日志记录和查询功能
监控系统：内置服务器监控和缓存监控功能

开发流程

需求分析：明确功能需求和业务逻辑
数据库设计：设计数据库表结构
代码生成：使用代码生成器生成基础代码
业务逻辑开发：完善业务逻辑和接口
前端开发：开发前端页面和交互
测试：进行单元测试和集成测试
部署：部署到生产环境

开发注意事项

权限控制：所有API接口必须添加权限控制
数据验证：所有输入数据必须进行验证
异常处理：统一处理API异常
日志记录：关键操作必须记录日志
性能优化：注意API性能优化，避免慢查询
代码规范：遵循PEP8和项目代码规范

部署说明

本地开发

# 启动后端服务
cd backend
python main.py run --env=dev

# 启动前端服务
cd frontend
pnpm run dev

# 启动移动端服务
cd fastapp
pnpm run dev:h5

Docker部署

# 执行一键部署脚本
./deploy.sh

# 查看运行状态
docker compose ps

# 查看日志
docker logs -f <container_name>

技术支持

官方文档：https://service.fastapiadmin.com
GitHub：https://github.com/1014TaoTao/FastapiAdmin
Gitee：https://gitee.com/tao__tao/FastapiAdmin

常见问题

Q：如何添加新功能模块？

A：按照二次开发步骤，在 backend/app/plugin/ 目录下创建新的模块目录，编写相关代码即可。

Q：如何配置数据库？

A：在 backend/env/.env.dev 或 backend/env/.env.prod 文件中配置数据库连接信息。

Q：如何配置Redis？

A：在 backend/env/.env.dev 或 backend/env/.env.prod 文件中配置Redis连接信息。

Q：如何生成数据库迁移文件？

A：使用 python main.py revision --env=dev 命令生成迁移文件。

Q：如何应用数据库迁移？

A：使用 python main.py upgrade --env=dev 命令应用迁移。

Q：如何启动开发服务器？

A：使用 python main.py run --env=dev 命令启动开发服务器。

Q：如何构建前端生产版本？

A：使用 pnpm run build 命令构建前端生产版本。

Q：如何部署到生产环境？

A：使用 ./deploy.sh 脚本一键部署到生产环境。

ℹ️ 帮助

更多详情请查看官方文档

👥 贡献者

🙏 特别鸣谢

感谢以下开源项目的贡献和支持：

🎨 社区交流

群组二维码	微信支付二维码

❤️ 支持项目

如果你喜欢这个项目，请给我一个 ⭐️ Star 支持一下吧！非常感谢！

22 KiB Raw Blame History Unescape Escape

FastApiAdmin v2.0.0