Magic-API介绍

1.1 背景

现在的技术发展日新月异，客户对软件系统的需求也是越来越庞大，对体验的要求越来越高。间接促进对软件系统架构的优化，软件开发岗位的细分。需要更多的人参与这个过程中，其中软件接口是整个团队合作过程中非常重要的衔接桥梁。但是接口大部分都是简单的增删改查的工作，相当乏味，相当占用程序员时间。所以需要有一个平台能把基础的接口开发工作完成，开发人员只需要关注里面的业务逻辑开发，就能极大的提高开发效率，增强开发人员的成就感，发挥他们真正的价值。

程序员中还有一部分特殊的人群-数据开发工程师，就是传说中的SQLBoy。SQL写的溜，但对开发接口不知道如何下手。他们又想快速的把加工的数据开放出来提供给其他使用使用。这时候也需要一个平台提供一个编写SQL就能提供接口的地方，可能成为SQLBoy的神器。

1.2 产品选型

要求：

• 通过表快速生成API
• 可视化配置开发界面
• 灵活的业务逻辑支持
• 支持多数据源
• 方便集成

筛选出的几个产品

• Dataway https://www.hasor.net/doc/display/dataway
• Magic-API ssssssss-team
• Rocket-API-Platform rocket-api-platform: 服务端面向SQL开发API的低代码平台。来源于rocket-api,可以实现在页面上动态管理多数据源配置可以用于作统一的数据接口平台

功能	Magic-api	Dataway	Rocket-api
开源协议	MIT License	Apache-2.0 License	Apache-2.0 License
数据源支持	支持关系型数据库，redis，mongodb，es插件方式支持，其他可以扩展；支持多数据源	关系型数据库；支持多数据源	关系型数据库，Mongodb，ClickHouse，其他可以扩展；支持多数据源
鉴权	支持	支持	无
脚本支持	类似js语法；支持java导入，支持自定义脚本语言	DataQL	支持groovy语法
stars	2.4	1.1k	1.2k

3个对比，功能基本上都差不多；Magic-API对权限这块相对完善，脚本支持相对强大，协议相对开发，集成比较简单。

1.3 Magic-API特性

• 支持MySQL、MariaDB、Oracle、DB2、PostgreSQL、SQLServer等支持jdbc规范的数据库
• 支持非关系型数据库Redis、Mongodb、ElasticSearch
• 支持动态配置定时任务
• 支持集群部署、接口自动同步
• 支持分页查询以及自定义分页查询
• 支持多数据源配置，支持在线配置数据源
• 支持SQL缓存，以及自定义SQL缓存
• 支持自定义JSON结果、自定义分页结果
• 支持对接口权限配置、拦截器等功能
• 支持运行时动态修改数据源
• 支持Swagger接口文档生成
• 支持可插拔式的插件机制
• 支持i18n国际化
• 支持团队协作，可显示在线人数、以及他人正在编辑和浏览的接口等功能
• 基于magic-script (opens new window)脚本引擎，动态编译，无需重启，实时发布
• 支持Linq式查询，关联、转换更简单
• 支持数据库事务、SQL支持拼接，占位符，判断等语法
• 支持文件上传、下载、输出图片
• 支持脚本历史版本对比与恢复
• 支持脚本代码自动提示、参数提示、悬浮提示、错误提示
• 支持导入Spring中的Bean、Java中的类
• 支持在线调试
• 支持自定义工具类、自定义模块包、自定义类型扩展、自定义方言、自定义列名转换等自定义操作

1.4 工作方式改变

比较项目	以前	现在
接口开发周期	下周安排上线	等下就给接口
接口开发人员	数据人员需要接口开发人员支持	自己直接安排
接口定义	维护文档	直接系统定义查看
多数据源	目前系统不支持多数据源，同步到同一个库	都支持