历史版本16 :发布API-多值查询 返回文档
编辑时间: 内容长度:图片数:目录数: 修改原因:

目录:

1. 概述编辑

1.1 版本

FineDataLink版本
功能变动
4.0.28
支持使用 IN 语法实现多值查询

1.2 应用场景

用户想要在发布 API 时,对 API 取数逻辑进行设置:使用 SQL 的 IN 语句一个参数传入多值,对指定表的指定列做多值查询。

注:本文方案适用于 4.0.28 及之后版本;4.0.28 之前版本,请参见:历史文档

35.png

2. 操作步骤编辑

示例需要将「订单表」中数据发布为 API,并在取数时可同时取出多个地区(华北、华东、华南等等)的数据。

2.1 新建API

进入「数据服务」,新建 API 。如下图所示:

27.png

2.2 输入API信息

1)输入 API 名称,API 描述可为空,本文示例中请求方式选择 post,请求 Body 格式选择 application/json ,设置路径,将创建的 API 添加至应用中。如下图所示:

当然若此时没有创建应用,可不添加应用,在完成 API 创建后,在应用列表中绑定 API ,详情参见:绑定API至应用

注:API 的路径、请求Body格式等基本信息详情参见:发布API

20.png

2)点击「下一步」按钮。

2.3 设置发布内容及参数

1)选择要发布的数据源以及数据连接,然后输入查询 SQL 语句。如下图所示:

SELECT * FROM 订单表 WHERE 货主地区 IN ('${货主地区}')

该参数在 API 发布后,可在通过 API 取数时使用 SQL 语句设置的参数进行条件取数。

注1:示例为 MySQL 数据库语法,不同数据库的语法不同,用户可根据实际使用数据库类型修改语法。

注2:该步骤中,各设置项介绍请参见:发布API概述

30.png

2)点击「获取」按钮,输入华东','华北,可查询货主地区为华东、华北的数据。如下图所示:

1712738835287178.png

3)点击下一步

2.4 预览测试

1)进入预览测试步骤中,可在 Body 中填入参数值,如下图所示:

1712738978809329.png

点击测试调用按钮,即可看到测试接口返回结果。如下图所示:

33.png

2)点击「生成API」即可完成 API 生成。如下图所示:

34.png

2.5 API上线

右上角点击「上线」,即可发布 API,如下图所示:

34.png

3. 后续步骤编辑

若用户在发布时没有将 API 添加至指定应用,也可以在 API应用管理 中将上线的 API 通过应用进行管理,以便能够被调用。

若需要使用已经发布的API,详情参见:使用发布的API,调用效果如下图所示:

35.png

对已经发布的API进行管理,详情参见:服务运维