RuoYi-Vue3-FastAPI 项目完整教程

【免费下载链接】RuoYi-Vue3-FastAPI 基于Vue3+Element Plus+FastAPI开发的一个通用中后台管理框架（若依的FastAPI版本） 项目地址: https://gitcode.com/gh_mirrors/ru/RuoYi-Vue3-FastAPI

RuoYi-Vue3-FastAPI 是一个基于 Vue 3 + Element Plus + FastAPI 开发的通用中后台管理框架，是若依框架的 FastAPI 版本。该项目提供了完整的前后端分离解决方案，包含用户管理、角色管理、菜单管理、部门管理、岗位管理、字典管理、参数管理、通知公告、日志管理、在线用户、定时任务、缓存监控等丰富的功能模块。

项目目录结构

项目采用前后端分离架构，主要包含两个核心目录：

后端项目结构 (ruoyi-fastapi-backend/)

• app.py - 应用启动入口文件
• server.py - FastAPI 服务器配置和路由挂载
• config/ - 配置文件目录
• module_admin/ - 后台管理模块
• module_generator/ - 代码生成模块
• module_task/ - 定时任务模块
• utils/ - 工具类集合
• middlewares/ - 中间件处理
• exceptions/ - 异常处理

前端项目结构 (ruoyi-fastapi-frontend/)

• src/main.js - Vue 3 应用入口文件
• src/App.vue - 根组件
• src/views/ - 页面视图组件
• src/components/ - 公共组件
• src/api/ - API 接口定义
• src/assets/ - 静态资源文件
• src/router/ - 路由配置
• src/store/ - 状态管理
• vite.config.js - Vite 构建配置

启动文件详解

后端启动配置

后端主要通过 app.py 和 server.py 文件启动：

app.py - 应用启动入口：

import uvicorn
from server import app, AppConfig

if __name__ == '__main__':
    uvicorn.run(
        app='app:app',
        host=AppConfig.app_host,
        port=AppConfig.app_port,
        root_path=AppConfig.app_root_path,
        reload=AppConfig.app_reload,
    )

server.py - FastAPI 服务器配置：

• 初始化 FastAPI 应用实例
• 配置生命周期事件处理
• 挂载所有控制器路由
• 加载中间件和异常处理

前端启动配置

前端通过 src/main.js 文件启动 Vue 3 应用：

• 创建 Vue 应用实例
• 注册 Element Plus 组件库
• 配置全局指令和插件
• 挂载路由和状态管理

配置文件说明

后端配置文件

config/env.py - 主要配置文件：

• 应用配置 (AppSettings)：端口、主机、环境等
• JWT 配置 (JwtSettings)：密钥、算法、过期时间
• 数据库配置 (DataBaseSettings)：支持 MySQL 和 PostgreSQL
• Redis 配置 (RedisSettings)：连接参数
• 代码生成配置 (GenSettings)
• 上传配置 (UploadSettings)

配置文件支持通过环境变量和命令行参数加载不同的环境配置。

前端配置文件

vite.config.js - Vite 构建配置：

• 开发服务器配置（端口80，自动打开浏览器）
• 代理配置（转发到后端API）
• 别名配置（@ 指向 src 目录）
• 构建输出配置

package.json - 项目依赖配置：

• Vue 3、Element Plus、Pinia、Vue Router 等核心依赖
• 开发工具链配置（Vite、插件等）

项目特色功能

1. 完整的权限管理系统

基于角色的访问控制（RBAC），支持菜单权限、按钮权限的精细控制。

2. 代码生成器

内置强大的代码生成功能，可以根据数据库表结构自动生成前后端代码。

3. 多数据源支持

支持 MySQL 和 PostgreSQL 数据库，配置灵活切换。

4. 文件上传下载

支持多种文件格式上传，配置灵活的安全策略。

5. 定时任务管理

集成定时任务调度，支持动态添加、修改、删除任务。

6. 系统监控

提供服务器监控、缓存监控、在线用户监控等功能。

快速开始

环境要求

• Python 3.8+
• Node.js 16+
• MySQL 5.7+ 或 PostgreSQL 12+

后端启动步骤

1. 克隆项目：

git clone https://gitcode.com/gh_mirrors/ru/RuoYi-Vue3-FastAPI
cd RuoYi-Vue3-FastAPI

2. 安装后端依赖：

cd ruoyi-fastapi-backend
pip install -r requirements.txt

3. 配置数据库： 修改 config/env.py 中的数据库连接参数

4. 启动后端服务：

python app.py

前端启动步骤

1. 安装前端依赖：

cd ruoyi-fastapi-frontend
npm install

2. 启动前端开发服务器：

npm run dev

3. 访问应用： 打开浏览器访问 http://localhost:80

默认账号密码

• 用户名：admin
• 密码：admin123

项目架构优势

1. 技术栈先进：采用 Vue 3 + FastAPI 的现代化技术组合
2. 性能优异：前后端分离，接口响应快速
3. 扩展性强：模块化设计，易于二次开发
4. 文档完善：详细的代码注释和配置说明
5. 社区活跃：基于若依生态，有丰富的社区支持

RuoYi-Vue3-FastAPI 是一个功能完善、易于上手的中后台管理系统解决方案，适合快速构建企业级管理平台。

【免费下载链接】RuoYi-Vue3-FastAPI 基于Vue3+Element Plus+FastAPI开发的一个通用中后台管理框架（若依的FastAPI版本） 项目地址: https://gitcode.com/gh_mirrors/ru/RuoYi-Vue3-FastAPI