自定义SQL配置参数

编写提示

关系型数据源

编写提示

目前只支持DQL语句,不支持DDL和DML语句。

  • API返回参数:SELECT查询的字段即为API返回参数。如果使用as语句定义了字段别名,则API返回参数名称为as语句后的字段别名。

  • API输入参数:WHERE条件中的参数为API请求参数。用户传参时,需要将输入参数写为${传入参数名}的格式。

示例
where user_id=${uid}
uid:表示API的输入参数,用户在在线测试API和调用API时,看到的输入参数为uid。
user_id:“=”号前的内容表示数据库中的实际字段。

ElasticSearch数据源

目前只支持DSL语句,且DSL严格遵循JSON的语法。

  • QUERY:用于指定查询条件。

  • TERM:类似SQL语句中的WHERE条件,WHERE条件中的参数为API请求参数。用户传参时,按照“表中字段名”:${传入参数名}的格式填写。

示例
"term": { "name": ${_name} }
_name:表示API的输入参数,用户在在线测试API和调用API时,看到的输入参数为_name。
name:“=”号前的内容表示数据库中的实际字段。

数据源配置

用户需要选择读取的数据库类型、数据源和数据表。

通过数据预览可查看当前选中数据表的字段和数据,便于快速排查选择的数据表是否正确。

忽略语法校验

勾选后,系统将不再校验输入输出字段在表中是否存在,若字段不存在则判定为无效字段,不进行报错。不支持忽略ElasticSearch的语法校验。

格式化语句

将写入的SQL语句格式化为对应数据库SQL书写的标准格式,不支持ElasticSearch的点格式化。

编辑参数

点击“编辑参数”,系统将解析当前SQL代码,得到输入参数与输出参数的关系映射并展示,帮助用户快速确认API配置逻辑是否有误。

SQL
SQL关系映射

高级配置

  • 支持分页查询:若选择分页查询,则输出结果分页展示,每页最大返回结果为1000条数据。当输出结果大于1000条数据时,系统强制分页。

  • 反馈结果携带分页参数:勾选此选项,用户可查看其他的数据参数。

    • currentPage:当前页码

    • totalPage:总页数

    • totalCount:总记录数,如共258条

    • pageSize:每页记录数,如20条/页

  • 返回结果中携带Request Header 参数:勾选此选项,用户可在输出结果中获取request header参数如下:

    • "Content-Encoding": web服务器支持的反馈内容压缩编码类型。

    • "Connection":表示是否需要持久连接。

    • "User-Agent":请求的用户代理。

    • "Host":指定请求的服务器的域名和端口号。

    • "Accept-Encoding":指定浏览器可以支持的web服务器反馈内容压缩编码类型。

    • "Content-Length": 请求的内容长度。

    • "Content-Type": "请求的与实体对应的MIME信息。