SQL 类型接口
SQL 语句就是 API,简单/快速,略微了解 SQL 语言即可快速开发API
接口设计
- 在左侧接口列表中选择要编辑的接口,然后点击标签
接口设计
中的设计
按钮,此时会弹出设计界面接口设计界面如下: 左侧为数据源列表,右上侧为接口设计界面,右下侧为SQL调试结果
- 先选择数据源,若数据源所在网关离线,是无法在线调试的
- 选择数据源后左侧会展开数据源详情(数据表信息)
- 在表上单击鼠标右键,可以选择针对此表的快速查询语句
- 单击数据表名称,会展开数据表的字段信息,此时可在字段名称上单击鼠标右键,选择将表名称插入到编辑器
- 编写SQL 后点击
运行SQL
按钮 即可在线运行SQL (若是大量查询,请务必勾选分页
) 关于如何编写SQL, 详见 SQL 语句编写指南 - 参数
分页
功能:- 若SQL不是查询语句,请勿勾选(否则会出现异常);
- 若查询结果是大量多行数据时,请务必勾选此项以启用分页功能,以避免数据量过大影响效率
- 可排序字段: 定义支持的排序字段,接口请求时可以通过参数实现动态排序
- SQL参数: 根据 SQL 语句自动生成的动态参数,基本属性有:
- 类型: 可用于校验在接口调用时 http 请求中所携带参数的数据类型,若不匹配,会返回异常
- 默认值: 若接口调用时 http 请求中未携带此参数,则使用默认值
- 值: 当前调试时使用的值
- 说明: 可以写点描述,提高 SQL 查询的可读性和可维护性
- 接口设计完成后 点击下方的保存按钮即可
- 支持前后置操作,详细示例请参考前后置操作