发布API-忽略参数查询条件

1.1 版本

1.2 应用场景

用户想要在发布API 时，对 API 取数逻辑进行设置：未传指定参数，则省略此参数对应的查询条件。即实现想查询全部数据时，不传对应参数；要查询其他非空值数据时，正常传参。

FineDataLink 支持配置参数为必填 / 非必填。

示例需要将 S订单中数据发布为 API，并在取数时不传递参数「area」，则取出全部的数据，当正常传递「area」参数，则查询其他非空值数据。

2.1 新建API

进入「数据服务」，点击「新建>API」，进入API 发布编辑界面，如下图所示：

2.2 输入API信息

设置 API名称、可对API进行描述说明，同时设置发布的API 的路径，选择请求方式，此处使用了 GET 请求方式，并选择是否开启认证，设置超时时间，然后可将创建的 API 添加至应用中，如下图所示：

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

API的请求路径、请求格式、返回格式等基本信息详情参见：发布API

注：若用户想要对发布的API进行层级设计，可以使用连字符（-）、正斜杠（/）等符号设计API路径，如下图所示：

2.3 设置发布内容及参数

选择要发布的数据源以及数据连接，然后输入查询 SQL 语句，如下图所示：

SELECT * FROM S订单 WHERE 1=1 AND CASE WHEN ${area} != '' THEN 货主地区=${area} ELSE 1=1 END

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

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

请求参数配置中会自动识别查询 SQL 设置的参数名，可以定义该参数的参数类型，由于此时希望实现使用API时不引用参数，默认取出所有的数据，因此取消勾选「参数必填」并设置默认值为 ''，即为空，如下图所示：

注：此时若调用 API ，则SQL 语句会将默认值空带入，即执行SELECT * FROM S订单 WHERE 1=1 AND CASE WHEN '' != '' THEN 货主地区='' ELSE 1=1 END，即查询出全量数据。

若设置默认值为 NULL 时，则SQL 语句会将默认值 NULL 带入，即执行 SELECT * FROM S订单 WHERE 1=1 AND CASE WHEN NULL != '' THEN 货主地区=NULL ELSE 1=1 END,此时的执行结果取决于数据库读取情况。

点击查询预览，输入预览参数值，点击「预览」，如下图所示：

即可看到满足条件的预览结果，如下图所示：

2.4 预览测试

点击下一步进入「预览测试」界面。

点击「测试API调用」，选择在API信息中已绑定的应用，然后输入请求参数值进行测试，即可看到测试接口返回结果，如下图所示：

点击「生成API」即可完成API生成，如下图所示：

2.5 API上线

API列表展示所有API信息，选择指定的API ，可查看基本信息和API 的内容以及参数。

在右上角点击「上线」，即可发布 API，如下图所示：

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

若需要使用已经发布的API，详情参见：使用数据服务发布的API（GET 请求）

可看到参数为空，即不传对应参数 area 时，取全部的数据，如下图所示：

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