03.界面操作说明

# 动态接口维护主界面

avatar

# 接口目录操作说明

接口目录：接口目录树，树结构展示能够更方便查找。

清除接口缓存：将动态接口执行的sql语句，从redis的全部清除。
添加目录：添加的是接口目录。 *鼠标移入到接口目录数据上，会显示新增，修改，删除。
新增：是新增动态DBApi接口
修改：是修改接口目录
删除：删除是删除当前接口目录，如果接口目录里面存在动态接口未删除，那需要删除动态接口才能删除接口目录。鼠标移入到动态接口数据上，会显示修改，删除。
修改：是修改动态接口信息
删除：是删除动态接口信息，删除需谨慎，可能会导致某些应用无法使用。

点击具体的接口,可查看调用接口的详细帮助文档。

# 接口-文档

请求地址：comm/apiComm/form_a2aq.queryChartList http Api地址调用的后端具体的地址是：后端域名+"/comm/apiComm/form_a2aq.queryChartList"
Api类型：接口的类型，主要分为操作接口，查询列表接口，分页列表接口，获取对象接口，导入xls接口五种类型接口。

1)操作接口：可以执行插入，修改数据，修改表结构的sql语句。

2)查询列表接口：是不分页，查询所有数据的接口，需要配置列头信息。

3)分页列表接口：需要传入页码，每页多少行，查询结果会自动分页返回。

4)获取对象接口：根据查询条件，只会返回第一行的数据。

5)导入xls接口：需要上传模板xls，并配置模板xls的列对应列表列。

执行Sql：接口执行动态Sql
接口说明：针对接口的描述
请求参数：针对请求接口的一个详细说明文档。

1）参数名称：参数变量名

2）参数类型：常量，数组，Object三种类型。

3）是否必填：后端验证参数是否必填

4）验证类型：后端提供了常用的一些验证类型，验证参数的格式。

5）查询默认控件：使用该接口生成列表查询条件时的默认查询条件的控件。

6）验证提示：验证不通过的时提示的名称。

# 接口-调试

avatar

1)发送请求：测试调试接口，当参数为空时，会加载参数模板。 2)加载参数模板：加载参数模板。 3)导出：测试导出

# 动态接口维护界面

# 接口基本信息

avatar

Api名称：定义接口的名称，方便查找。

ApiCode：定义接口的编码名称，只能输入字符串与数字，编码不能重复

Api类型：接口的类型，主要分为操作接口，查询列表接口，分页列表接口，获取对象接口，导入xls接口五种类型接口，

1)操作接口：可以执行插入，修改数据，修改表结构的sql语句。

2)查询列表接口：是不分页，查询所有数据的接口，需要配置列头信息。

3)分页列表接口：需要传入页码，每页多少行，查询结果会自动分页返回。

4)获取对象接口：根据查询条件，只会返回第一行的数据。

5)导入xls接口：需要上传模板xls，并配置模板xls的列对应列表列。

数据源：默认是业务库。

xls模板：上传导入xls模板

模板路径：xls模板的路径

开始行数：导入xls的行数

接口说明：对接口进行描述。

接口执行sql内容：在线编辑sql接口，具体的语法请参考【脚本语法】帮助文档。

# sql编辑帮助文档

SQL编辑器会针对接口的环境变量、常用标签，表名，表字段有提示。

快捷插入脚本

'$in'+表名回车快速生成对应表的新增sql,生成sql如下：

insert into test_data (id,name) values(#{id},#{name})

'$UP'+表名回车快速生成对应表的update sql

update  test_data set  flastupdatedate=now(),flastupdateby=#{$user.userId}
<if test="id!=null and id!=''">, id=#{id}</if>
<if test="name!=null and name!=''">, name=#{name}</if>
 where fid=#{fid}

1
2
3
4

'$sl'+表名回车快速生成对应表的查询语句

 select * from   test_data  <where> <if test="id!=null and id!=''">and id=#{id}</if>

<if test="name!=null and name!=''">and name=#{name}</if>
 </where>