【限时免费】 SmartAdmin 技术文档

1. 安装指南

1.1 环境要求

• 前端环境：
  • Node.js 16+
  • npm 8+/yarn 1.22+
  • Vue3/Vite5环境
• 后端环境：
  • Java8/Java17
  • Maven 3.6+
  • SpringBoot2/SpringBoot3
  • MySQL 5.7+/Oracle 12c+/PostgreSQL 11+/国产数据库

1.2 数据库准备

1. 创建数据库实例
2. 执行项目中的SQL初始化脚本
3. 配置数据库连接参数

1.3 前端安装

# 克隆项目
git clone https://github.com/1024lab/smart-admin.git

# 进入项目目录
cd smart-admin-front

# 安装依赖
npm install

# 启动开发环境
npm run dev

1.4 后端安装

# 进入后端目录
cd smart-admin-backend

# 编译项目
mvn clean install

# 启动应用
java -jar target/smart-admin.jar

2. 项目使用说明

2.1 系统登录

1. 访问系统登录页面
2. 使用默认管理员账号登录：
   • 用户名：admin
   • 密码：123456
3. 首次登录需修改密码

2.2 核心功能模块

• 系统管理：用户、角色、权限、菜单管理
• 安全中心：登录日志、操作审计、安全策略
• 数据管理：数据字典、系统参数
• 开发工具：代码生成器、接口文档
• 监控中心：系统监控、服务心跳

2.3 特色功能

1. 表格自定义列：用户可自定义显示列并保存
2. 数据变更记录：基于git diff的数据变更追踪
3. 在线文档系统：集成式帮助文档
4. 多环境支持：开发/测试/生产环境一键切换

3. 项目API使用文档

3.1 API规范

• 采用RESTful风格设计
• 统一返回格式：

{
  "code": 200,
  "message": "success",
  "data": {}
}

3.2 安全认证

• 使用Sa-Token进行认证
• 请求头需携带：

  Authorization: Bearer {token}
  

3.3 核心API示例

用户登录

POST /api/auth/login
Content-Type: application/json

{
  "username": "admin",
  "password": "加密后的密码"
}

获取用户信息

GET /api/user/info
Authorization: Bearer {token}

分页查询用户列表

GET /api/user/list?page=1&size=10
Authorization: Bearer {token}

4. 项目安装方式

4.1 标准安装

1. 下载发布包
2. 解压到指定目录
3. 配置application.yml
4. 启动服务

4.2 Docker安装

# 拉取镜像
docker pull smartadmin/official

# 运行容器
docker run -d -p 8080:8080 \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://host:port/db \
  -e SPRING_DATASOURCE_USERNAME=root \
  -e SPRING_DATASOURCE_PASSWORD=123456 \
  smartadmin/official

4.3 开发模式安装

1. 使用IDE导入项目
2. 配置开发环境参数
3. 启动前后端联调模式

5. 注意事项

1. 生产环境必须修改默认密码
2. 建议启用HTTPS加密传输
3. 定期备份数据库
4. 关注官方文档获取最新安全更新