Skip to content

如何新建第一个数据API

此章节主要介绍如何添加系统从启动开始,在添加数据源之后,如何新建第一个简单的数据API。

此处主要是以系统管理员来创建API为例来进行的(实际上API管理员也是可以创建数据API的,但不能给业务用户相关的数据API调用权限)。

在创建数据API前需要先由系统管理员admin将API路径和API的业务目录先创建好,这样才能给后续的系统管理员或API管理员创建API的时候来使用。

1 新建API路径

目前系统默认的路径格式为/maicong/quickapi的两层路径,以下的创建路径的方式和主要的图示:

然后开始新建第一级路径和第二级的路径就可以了。

2 新建API业务目录

进入到数据API的配置和操作页面后,会看到一个空的系统,里面没有数据API也没有其他用户信息,admin 作为系统管理员也是超级管理员

以下的系统中如何添加业务目录的示例,业务目录分为两级目录,满足大部分企业的管理需求,此处以第一级目录名称为人事部门,二级目录为员工信息为例进行目录的创建。

然后开始新建第一级目录和第二级的目录就可以了。

3 新建第一个API

接下来我们开始创建第一个数据API的业务。

我们将根据业务的提示开始一步一步地创建我们的第一个数据API,以下的主要的图示:

第一步:填写相关的基本信息,其中API路径和目录是在前面创建好的,用户可以选择。

第二步:选择需要处理的相关的数据库的基本信息,此处我们选择了mysql的数据源信息和test数据库,同时打开了相应的表结构信息。

另外,在输入好SQL语句后,我们使用了辅助抽取参数的功能协助抽取了输入和输出参数。

关于如何使用参数的方法,此处有相关的提示,可以点击代码开发帮助来获取如何开发的方法。

第三步:开始测试API是否是正确的,如下图所示,在测试成功后就可以发布API了。

恭喜您!现在您已经可以看到刚刚创建好的数据API信息了。

接下来我们会开始进入到下一个部分:如何开始调用数据API。