芋道 ruoyi-vue-pro 技术文档

1. 安装指南

1.1 环境要求

• JDK版本：
  • JDK 8 + Spring Boot 2.7（master分支）
  • JDK 17/21 + Spring Boot 3.2（master-jdk17分支）
• 数据库：MySQL 5.7+（支持Oracle/PostgreSQL/SQL Server等）
• Redis：5.0+
• Node.js：14+（前端开发需要）

1.2 后端安装

1. 克隆仓库：

   git clone https://gitee.com/zhijiantianya/ruoyi-vue-pro.git
   

2. 创建数据库：

   CREATE DATABASE `ruoyi-vue-pro` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
   

3. 导入SQL脚本：

   mysql -uroot -p ruoyi-vue-pro < sql/init.sql
   

4. 修改配置：

   # application-dev.yml
   spring:
     datasource:
       url: jdbc:mysql://localhost:3306/ruoyi-vue-pro
       username: root
       password: 123456
   redis:
     host: localhost
     port: 6379
   

1.3 前端安装

1. 安装依赖：

   cd yudao-ui-admin-vue3
   npm install
   

2. 配置API地址：

   # .env.development
   VITE_API_BASE_URL = http://localhost:48080
   

2. 项目使用说明

2.1 启动项目

后端启动：

mvn spring-boot:run

前端启动：

npm run dev

2.2 系统功能

1. 用户管理：

   • 新增/编辑/删除系统用户
   • 分配用户角色和部门

2. 角色管理：

   • 配置菜单权限和数据权限
   • 支持按部门设置数据范围

3. 菜单管理：

   • 动态路由配置
   • 按钮权限控制

4. 租户管理（SaaS功能）：

   • 多租户隔离
   • 自定义租户套餐

3. API使用文档

3.1 认证接口

登录接口：

POST /admin-api/system/auth/login
{
  "username": "admin",
  "password": "admin123"
}

响应示例：

{
  "code": 200,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiJ9...",
    "userInfo": {
      "userId": 1,
      "username": "admin"
    }
  }
}

3.2 用户管理接口

获取用户列表：

GET /admin-api/system/user/page?pageNo=1&pageSize=10
Headers:
  Authorization: Bearer {token}

创建用户：

POST /admin-api/system/user/create
{
  "username": "test",
  "password": "123456",
  "nickname": "测试用户",
  "deptId": 100
}

4. 项目安装方式

4.1 完整版安装

1. 推荐使用JDK 17 + Spring Boot 3.2版本：

   git clone -b master-jdk17 https://gitee.com/zhijiantianya/ruoyi-vue-pro.git
   

2. 使用Maven构建：

   mvn clean install
   

4.2 精简版安装

1. 克隆精简版仓库：

   git clone https://gitee.com/yudaocode/yudao-boot-mini.git
   

2. 按需迁移模块（参考迁移文档）

4.3 Docker部署

# 后端服务
docker-compose up -d yudao-server

# 前端服务
docker-compose up -d yudao-ui

---

以上文档提供了芋道ruoyi-vue-pro项目的完整技术说明，包含安装、使用和API开发指南。如需更详细的功能说明，可查阅项目Wiki文档。