# SolonMagicApi

**Repository Path**: harbin-youma/solon-magic-api

## Basic Information

- **Project Name**: SolonMagicApi
- **Description**: SolonMagicApi 是基于 Solon 框架，参照 Magic-api 项目搭建的一款高效、灵活的接口快速开发框架。它允许开发者通过脚本化的方式快速构建和部署 HTTP API 接口，无需编写传统的 Java 代码，极大地提高了接口开发效率。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2026-03-04
- **Last Updated**: 2026-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SolonMagicApi 项目概述

## 项目简介

SolonMagicApi 是基于 Solon 框架，参照 Magic-api 项目搭建的一款高效、灵活的接口快速开发框架。它允许开发者通过脚本化的方式快速构建和部署 HTTP API 接口，无需编写传统的 Java 代码，极大地提高了接口开发效率。

## 核心特性

### 1. 脚本化接口开发
- **无代码/低代码开发**：通过编写脚本文件即可创建 HTTP 接口
- **快速部署**：脚本修改后立即生效，无需编译和重启服务
- **灵活的脚本语法**：支持 JavaScript 语法，内置丰富的工具函数

### 2. 丰富的功能模块
- **数据库操作**：支持多种数据库的查询和操作
- **Redis 操作**：内置 Redis 操作模块
- **HTTP 请求**：支持发送 HTTP 请求
- **定时任务**：支持创建和管理定时任务
- **文件操作**：支持文件的上传和下载
- **工具类集成**：集成了常用的工具类库

### 3. 友好的前端界面
- **脚本编辑器**：基于 Monaco Editor 的代码编辑环境，支持语法高亮和代码提示
- **多脚本标签页**：支持同时打开多个脚本进行编辑
- **脚本树管理**：可视化的脚本和分组管理
- **实时测试**：内置接口测试功能
- **全局搜索**：支持脚本内容的全局搜索和替换
- **主题切换**：支持明暗主题切换

### 4. 高性能与可扩展性
- **基于 Solon 框架**：轻量级高性能的 Java 框架
- **脚本缓存**：优化脚本执行性能
- **模块化设计**：支持功能模块的扩展
- **多数据源支持**：可配置多个数据源

## 技术栈

### 后端技术
- **Solon**：轻量级 Java 框架
- **Java**：核心开发语言
- **MagicScript**：脚本执行引擎
- **Redis**：缓存和数据存储
- **关系型数据库**：支持多种数据库

### 前端技术
- **Vue 3**：前端框架
- **TypeScript**：类型安全的 JavaScript 超集
- **Element Plus**：UI 组件库
- **Monaco Editor**：代码编辑器
- **Vite**：构建工具

## 应用场景

1. **快速原型开发**：快速构建 API 接口原型
2. **业务逻辑层**：将复杂的业务逻辑通过脚本实现
3. **数据接口层**：为前端或其他系统提供数据接口
4. **定时任务**：创建和管理定时执行的任务
5. **微服务架构**：作为微服务的一部分，提供特定功能的接口

## 快速开始

### 1. 环境要求
- JDK 1.8 或更高版本
- Maven 3.6 或更高版本
- Node.js 14 或更高版本（前端开发）

### 2. 项目启动

#### 后端启动
```bash
# 编译项目
mvn clean package

# 启动服务
java -jar target/solon-magic-api.jar
```

#### 前端启动
```bash
# 安装依赖
cd front
npm install

# 启动开发服务器
npm run dev
```

### 3. 访问系统
- 前端地址：http://localhost:5173
- 后端 API 地址：http://localhost:8900

## 项目结构

```
solon-project/
├── src/                 # 后端源码
│   ├── main/java/       # Java 代码
│   │   └── com/gr/magic/ # 核心包
│   ├── main/resources/  # 资源文件
│   │   ├── apis/        # 脚本文件
│   │   ├── scripts/      # 系统脚本
│   │   └── tasks/        # 定时任务
├── front/               # 前端源码
│   ├── src/             # 前端代码
│   │   ├── components/   # 组件
│   │   ├── views/        # 页面
│   │   └── api/          # API 调用
├── docs/                # 文档
├── pom.xml              # Maven 配置
└── README.md            # 项目说明
```

## 核心概念

### 脚本（Script）
脚本是接口开发的基本单位，每个脚本对应一个 HTTP 接口。脚本文件使用 `.ms` 扩展名，包含接口的实现逻辑。

### 分组（Group）
分组用于组织和管理脚本，支持多级分组结构。每个分组对应一个目录，包含该分组下的脚本文件。

### 定时任务（Task）
定时任务是在指定时间执行的脚本，支持 cron 表达式配置执行时间。

## 开发流程

1. **创建分组**：在左侧树状结构中创建脚本分组
2. **创建脚本**：在分组中创建新的脚本文件
3. **编写脚本**：在编辑器中编写接口逻辑
4. **测试接口**：使用内置的测试功能测试接口
5. **部署接口**：脚本保存后自动部署生效

## 安全特性

- **访问控制**：支持基于 token 的身份验证
- **接口权限**：可配置接口的访问权限
- **请求限制**：支持接口调用频率限制
- **日志审计**：记录接口调用日志

## 扩展与定制

### 插件系统
SolonMagicApi 支持通过插件扩展功能，可以：
- 添加新的脚本函数
- 集成第三方服务
- 自定义数据源

### 主题定制
前端界面支持主题定制，可以：
- 修改颜色方案
- 调整布局结构
- 添加自定义组件

## 贡献指南

我们欢迎社区贡献，包括：
- 功能增强
-  bug 修复
- 文档完善
- 测试用例

## 许可证

本项目采用 MIT 许可证，详见 LICENSE 文件。

## 联系与支持

- **项目地址**：https://gitee.com/yourusername/solon-magic-api
- **问题反馈**：在 GitHub 或 Gitee 上提交 issue
- **技术交流**：加入项目讨论群

---

SolonMagicApi 致力于为开发者提供简单、高效的接口开发体验，让接口开发变得更加轻松愉快。