Skip to main content

自定义返回接口字段

1、配置数据源连接

在规范设计-数据调研-数据管理,新增需要作为数据服务的数据来源库

2、新建 API 接口

在数据服务-API 管理-我的 API,新建 API

选择脚本模式

选择脚本模式,选取已配置好的数据源

编写查询 SQL

${args}:这个参数代码请求参数作为返回参数,根据输入的字段的多少,来返回对应的字段数据。

原理:进行 SQL 拼接,然后执行。

1)常见数据库作为数据来源

如:MySQL、Oracle、PostgreSQL、SQL server 等关系型数据库

操作步骤如下:

编写完 SQL 后,点击校验 SQL 参数进行 SQL 解析,自动解析请求参数和返回参数。

由于增加了 ${args},并且这个参数返回的字段是用户自定义的,所以需要在返回参数设置处,将此参数删除,默认按照参数返回的字段内容进行查询返回数据。

2)iotdb 作为数据来源

操作步骤如下:

编写完 SQL 后,点击校验 SQL 参数进行 SQL 解析,自动解析请求参数和返回参数。

由于增加了 ${args},并且这个参数返回的字段是用户自定义的,所以需要在返回参数设置处,将此参数删除,默认按照参数返回的字段内容进行查询返回数据。

需要在返回参数设置处,添加一个任意的参数来承接时间内容,默认会多给一个字段数据,所以需要添加一个返回字段进行承接。

API 测试

多个字段使用逗号隔开-英文状态的逗号

比如:id,name,age 则返回 id,nam,age 的数据

3、API 发布、调用

样例:

Url + ? + apiToken=01583d02a91945f1804dc3e9d68a65ec + & + args=id,name,age

http://120.195.198.50/api/v1/restData/ssssss?apiToken=01583d02a91945f1804dc3e9d68a65ec&args=id,name,age