接口大师工具介绍
接口大师 YesApi,是一套针对API接口进行快速研发、管理、开放以及收费的软件产品、源代码和解决方案。它基于PhalApi开源接口框架+Vue前后端分离,可用于快速搭建你的API接口平台。可以部署在本地内网,有5合1产品矩阵、源代码、完整文档,支持一键部署/可视化安装,“开箱即用”。
今天来分享一下,如何在不需要任何技术开发人员的情况下,只需要会写一条MySQL查询语句,就能在1分钟立即生成你的ERP数据接口API。
连接你的MySQL数据库
首先,在你的服务器上安装好接口大师YesApi后,先登录进入管理后台。
进入到【数据库管理 - 数据库配置管理】,接着【添加新数据库配置】。
根据数据库连接配置页面表单,填写你需要连接到本地的ERP数据库地址、账号、密码、端口等信息。
到这里,不需要任何编程基础,只需要拿到数据库账号密码配置进来即可。以后,就可以在接口大师界面上,轻松通过鼠标操作,编写SQL语句来生成你需要的API接口,减少开发成本、缩短开发时间。
编写一条SQL查询语句
为了方便教程演示,假设在ERP系统中,已经有一张 仓库信息表。表结构是,
CREATE TABLE `warehouse` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`warehouseId` int(11) DEFAULT NULL COMMENT '仓库ID',
`warehouseCode` varchar(20) DEFAULT NULL COMMENT '仓库代码',
`warehouseName` varchar(200) DEFAULT NULL COMMENT '仓库名称',
`warehouseType` int(11) DEFAULT '0' COMMENT '类型, 1:自营仓,2三方仓,3中转仓',
`warehouseStatus` int(11) DEFAULT '0' COMMENT '状态, 0:不可用;1:可用;-1:已废弃 ',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT '仓库表';
并且,假设已经存在以下仓库测试数据。
在熟悉现有的ERP数据库、表结构和业务数据后,可以在接口大师YesApi 继续进入【API接口管理 - 低代码接口开发 - 接口编辑器】,主要操作:
1、接口设计类型选择:根据一条SQL生成接口;
2、数据库配置管理,选择刚才新添加:ERP数据库;
3、在SQL语句编写你的查询SQL(支持带注释),例如:
-- 查询全部的仓库信息
select * from warehouse limit 0,100;
随后,依次进行界面的鼠标操作:
第1步、生成代码(如果要加装额外的程序逻辑,可自行调整);
第2步、保存草稿(方便后面可以继续回来调整数据接口);
第3步、保存并发布(让你的API接口正式生效)。
自动生成你的数据接口API
接下来,可以看到,在接口列表,会生成一个新接口:
App.ERPWarehouse.GetWarehouseList 获取仓库信息列表 根据请求获取对应仓库列表
以及在接口分类,也可以看到新增的 仓库接口模块。
再进入到接口文档详情页,可以看到生成好的API接口文档。
到这里,你所需要的API数据查询接口就完成了。整个过程,不需要专业的编程开发知识,只需要掌握SQL查询语句即可。通过编写SQL语句,来返回你的业务数据。
调用API接口和开放你的ERP数据接口
准备好了你的新接口后,可以自己通过网页,直接调试接口的使用。
可以看到,新接口可以正常返回你需要的所有仓库信息列表数据。
完整的接口返回结果是:
{
"ret": 200,
"data": {
"rows": [
{
"id": 1,
"warehouseId": 101,
"warehouseCode": "CNNT01",
"warehouseName": "南通中转仓UNITED STATES",
"warehouseType": 1,
"warehouseStatus": 1
},
{
"id": 2,
"warehouseId": 102,
"warehouseCode": "CNNT02",
"warehouseName": "南通标准仓",
"warehouseType": 2,
"warehouseStatus": 1
},
{
"id": 3,
"warehouseId": 201,
"warehouseCode": "USSEA03",
"warehouseName": "美西标准仓",
"warehouseType": 2,
"warehouseStatus": 1
},
{
"id": 4,
"warehouseId": 302,
"warehouseCode": "JPFBA1",
"warehouseName": "日本海外仓",
"warehouseType": 1,
"warehouseStatus": 1
}
]
},
"msg": ""
}
当需要开放你的ERP接口给外部使用时,只需要把这个接口文档的地址给你的下游合作伙伴和对应的客户即可。
例如复制以下信息:
获取仓库信息列表
根据请求获取对应仓库列表 获取仓库信息列表 HTTP/HTTPS GET/POST UTF-8 JSON v1.0
接口地址:
www.yesx2.com/api/app.php…接口描述: 根据请求获取对应仓库列表