Magic-API简介

本页面介绍Magic-API及其在MISEB系统中的应用。

什么是Magic-API

Magic-API是一款基于Java的接口快速开发框架，具有以下特点：

• 零代码/低代码：通过Web界面编写脚本即可完成接口开发
• 在线调试：支持在线实时调试，即时生效
• 多数据源：支持多种数据库和数据源
• 丰富函数：内置大量常用函数
• 可视化：提供可视化的API管理界面

为什么选择Magic-API

优势	说明
开发效率高	无需编译部署，实时生效
学习成本低	类JavaScript语法，易于上手
功能完整	数据库、缓存、HTTP请求等一应俱全
安全可控	不影响核心系统，独立运行
便于维护	接口集中管理，版本可控

在MISEB中的应用

访问地址

Magic-API管理界面访问地址：

http://your-domain.com/magic/web/index.html

默认账号

账号	密码	说明
admin	admin123	管理员账号

安全提示

首次登录后请立即修改默认密码

界面介绍

主要功能区

区域	功能
接口列表	左侧树形结构，管理所有接口
编辑区域	中间区域，编写接口脚本
参数配置	右侧区域，配置请求参数
调试面板	底部区域，查看执行结果

工具栏

按钮	功能
保存	保存当前接口
运行	执行当前接口
新建	创建新接口
删除	删除当前接口
历史	查看历史版本

核心概念

接口组

接口按组织结构分组管理：

/api/custom/
├── user/           # 用户相关
│   ├── list        # 用户列表
│   └── detail      # 用户详情
├── order/          # 订单相关
│   ├── statistics  # 订单统计
│   └── export      # 订单导出
└── report/         # 报表相关
    └── sales       # 销售报表

脚本语法

Magic-API使用类JavaScript语法，支持：

// 变量定义
var name = "MISEB";
var count = 100;

// 条件判断
if (count > 50) {
    return "大于50";
}

// 循环
for (item in list) {
    // 处理逻辑
}

// 函数调用
var result = db.select("SELECT * FROM users");

内置对象

对象	说明
db	数据库操作
redis	Redis操作
http	HTTP请求
log	日志输出
env	环境变量
request	当前请求
response	响应对象

数据源配置

系统已预配置以下数据源：

数据源	说明
master	主数据库（读写）
slave	从数据库（只读）
redis	Redis缓存

使用示例

// 使用主库
var users = db.select("SELECT * FROM eb_user LIMIT 10");

// 使用从库
var orders = db.slave.select("SELECT * FROM eb_store_order");

// 使用Redis
var cached = redis.get("user:1");

适用场景

推荐使用

• 自定义数据查询接口
• 报表统计接口
• 第三方系统数据同步
• 简单的业务逻辑处理
• 数据导出接口

不推荐使用

• 复杂的业务流程
• 高并发核心接口
• 需要事务的复杂操作
• 涉及敏感数据的操作

下一步

• 快速入门 - 创建第一个接口
• 接口开发 - 详细开发指南
• 数据库操作 - 数据库相关操作