第4章 设计API

4.1 创建API接口组

新建一个API接口组 新建API接口组

4.2 调试SQL

接口设计,配置个接口路径、然后编辑调试SQL API设计

这里是调试SQL界面

  • 左侧: 查询网关、数据库、表名、字段;
  • 上侧: 选择数据源;
  • 中间: SQL编辑区,
  • 右侧: SQL参数修改区;
  • 下侧: 执行结果

SQL调试器界面

4.3 SQL参数

您可以在SQL语句中使用【:】后跟参数名称来定义参数,然后在 右侧【SQL参数】 区域选择相应的 【数据类型】

【默认值】:会影响正式开发的API和调试界面;当参数为空会提示"message": “参数异常,缺少参数 ‘xx’"。

【示例值】:只用于接口调试界面使用给开发人员使用,优先级更高。 SQL参数说明

SQL调试器编辑完成即可发布,但不能被调用,出于安全原则,必须指定访问策略,详见下一章节。

带参API设计完成