1. 概述编辑
1.1 版本
| FineDataLink版本 | 功能变动 |
|---|---|
| 4.0.20.1 | - |
1.2 应用场景
用户需要把上游数据采集、加工好以后，存到指定数据库，希望将这些数据封装成 API 接口，供下游系统调用。
1.3 功能说明
FineDataLink 支持将处理好的数据库中的数据通过 API 形式发布出去，供其他工具使用。
1.4 约束限制
1）当前支持的API发布的数据库版本为：MySQL、Oracle、PostgreSQL、SQLServer
2）当前仅支持FineDataLink独立部署版本使用。
3）仅超级管理员能管理和编辑 API ，其他用户无权看到「数据服务」模块。
2. 前提条件编辑
1）配置数据源。在进行数据服务新建API之前，需要将已经处理好的需要发布的数据对应数据库接入 FineDataLink，以便在API发布配置过程中，可通过选择数据源名称来控制需要发布的数据，详情参见：配置数据连接
2）进行认证配置，在设置后当其他系统调用已经发布的API时，需要进行鉴权认证方式、黑白名单设置，从而让使用 API 接口更安全，详情参见：配置发布环境
3. 操作步骤编辑
3.1 新建API
进入「数据服务」，点击「新建>API」，进入API 发布编辑界面，如下图所示：
3.2 输入API信息
设置 API名称、可对API进行描述说明，同时设置发布的API 的路径，并选择是否开启认证，最后设置超时时间，如下图所示：
API的请求路径、请求格式、返回格式等基本信息说明如下所示：
配置项 | 说明 | |
|---|---|---|
| API名称 | 配置API名称。 API名称不允许重复。 默认为空，最大长度50字符，必填。 | |
| API描述 | 配置API描述。 默认为空，最大长度100字符，非必填。 | |
| 请求方法 | 请求方法。 当前支持 POST，必填。 | |
| API路径 | 配置要发布的API路径。 API路径不允许重复。 注：仅允许指定单层路径，不允许再分路径。 默认为空，最大长度100字符，仅允许填写小写字母和数字，必填。 例如以下完整的API请求路径示例： http://192.168.5.175:8089/webroot/service/publish/demo 注：service前的部分为发布API所在的当前 FineDataLink 服务器地址。 | |
| 开启认证 | API是否需要认证。 如果取消勾选，意味着关闭认证，该API可以免认证被任何人访问。 | |
| 超时时间 | 填写响应超时时间，如果在指定时间后仍没有返回查询结果，则接口返回超时错误。 默认10000ms，必填。 | |
3.3 设置发布内容及参数
选择要发布的数据源以及数据连接，然后输入查询 SQL 语句，如下图所示：
select * from S订单 where 订购日期>${dtime}
请求参数配置中会自动识别查询 SQL 设置的参数名，可以定义该参数的参数类型，并进行描述，如下图所示：
请求参数配置说明如下：
注：不支持用户使用参数配合IN语法过滤、不支持动态列、动态筛选，一个参数不支持传递多个值。
列表项目 | 说明 |
|---|---|
| 参数名称 | 请求参数名。 参数名称不可重名。 默认为空，必填。 |
| 参数类型 | 请求参数类型。
注：对于日期类型参数标识为字符串，使用字符串形式传入，格式举例：【yyyy-MM-dd HH:mm:ss】 |
| 描述 | 为参数添加描述。 默认为空。 |
点击查询预览，输入预览参数值，点击「预览」，如下图所示：
注：为了解决 SQL 防注入问题，SQL语句参数不允许加引号，从数据库工具复制过来的 SQL 需要手动删除参数引号，在查询预览的时候手动给参数默认值加引号进行预览。
即可看到满足条件的预览结果，如下图所示：
3.4 预览测试
点击下一步进入「预览测试」界面。
点击「测试API调用」，输入请求参数值，补充 body 内容进行测试，如下图所示：
即可看到测试接口返回结果，如下图所示：
点击「生成API」即可完成API生成，如下图所示：
3.5 API上线
API列表展示所有API信息，选择指定的API ，可查看基本信息和API 的内容以及参数。
在右上角点击「上线」，即可发布 API，如下图所示：
