1. 概述
1.1 版本
FineDataLink版本 | 功能变动 |
---|---|
4.0.28 | 数据发布 API 参数支持传入 NULL 值 |
1.2 应用场景
用户想要在发布 API 时,对 API 取数逻辑进行设置:取出发布的 API 中为 NULL 的数据,同时也能正常查询其他数据。
FineDataLink 支持 API 参数传入 NULL 值。
注:本文方案适用于 4.0.28 及之后版本;4.0.28 之前版本,请参见:历史文档
2. 操作步骤
本文示例:将「订单表」中的数据发布为 API,并在取数时可取出货主省份为 NULL 值的数据,同时也能正常查询其他数据。
2.1 新建API
进入「数据服务」,新建 API 。如下图所示:
2.2 输入API信息
1)输入 API 名称,API 描述可为空,本文示例中请求方式选择 post,请求 Body 格式选择 application/json ,设置路径,将创建的 API 添加至应用中。如下图所示:
当然若此时没有创建应用,可不添加应用,在完成 API 创建后,在应用列表中绑定 API ,详情参见:绑定API至应用
注:API 的路径、请求Body格式等基本信息详情参见:发布API
2)点击「下一步」按钮。
2.3 设置发布内容及参数
1)选择要发布的数据源以及数据连接,然后输入查询 SQL 语句;请求参数配置中,「参数必填」按钮关闭,即参数可以为空,参数默认值为 NULL。
SELECT * FROM `demotest`.`订单表` WHERE IF('${province}'='NULL',货主省份 IS NULL,货主省份 ='${province}')
该参数在 API 发布后,可在通过 API 取数时使用 SQL 语句设置的参数进行条件取数。
注1:示例为 MySQL 数据库语法,不同数据库的语法不同,用户可根据实际使用数据库类型修改语法。
注2:该步骤中,各设置项介绍请参见:发布API概述
2)点击「获取」按钮,输入 NULL,可查询「货主省份」为空的数据。如下图所示:
输入「北京」,可查询「货主省份」为北京的数据。
3)点击「下一步」。
2.4 预览测试
1)进入「预览测试」步骤中,可在 Body 中填入参数值,如下图所示:
点击「测试调用」按钮,即可看到测试接口返回结果。如下图所示:
2)点击「生成API」即可完成 API 生成。如下图所示:
2.5 API上线
右上角点击「上线」,即可发布 API,如下图所示:
3. 后续步骤
若用户在发布时没有将 API 添加至指定应用,也可以在 API应用管理 中将上线的 API 通过应用进行管理,以便能够被调用。
若需要使用已经发布的 API,详情参见:使用数据服务发布的API(POST application/json请求)
可看到取出参数为 NULL 值的数据,如下图所示:
对已经发布的 API 进行管理,详情参见:服务运维