1. 概述编辑
1.1 版本
| FineDataLink版本 | 功能变动 |
|---|---|
| 4.0.20.1 | - |
| 4.0.26 | 非超级管理员支持使用数据服务 |
| 4.0.27 | 支持使用 FineBI 公共数据作为数据来源 |
| 4.0.28 | 数据发布API 支持设置 SQL防注入，以便使用 IN 语法实现多值查询 数据发布API参数支持传入NULL值 数据发布API参数支持配置必填 / 非必填 数据发布API支持GET请求方式 数据发布API的POST请求方式，额外支持x-www-form-urlencoded格式 |
| 4.1 |
|
1.2 应用场景
用户需要把上游数据采集、加工好以后，存到指定数据库，希望将这些数据封装成 API 接口，供下游系统调用。
1.3 功能说明
FineDataLink 支持将处理好的数据库中的数据通过 API 形式发布出去，供其他工具使用。
1.4 约束限制
1）当前支持的 API 发布的数据库版本为：MySQL、Oracle、PostgreSQL、SQLServer、Greenplum（包含并行装载）、FineBI 公共数据（详情参见：使用FineBI公共数据发布API）
2）当前仅支持FineDataLink独立部署版本使用。
2. 前提条件编辑
1）非超级管理员用户想要使用该功能需要为用户分配 数据服务管理权限。
2）配置数据源。在进行数据服务新建API之前，需要将已经处理好的需要发布的数据对应数据库接入 FineDataLink，以便在API发布配置过程中，可通过选择数据源名称来控制需要发布的数据，详情参见：配置数据连接
3. 功能说明编辑
3.1 API 信息
API的请求路径、请求格式、返回格式等基本信息说明如下所示：
配置项 | 说明 | |
|---|---|---|
| 名称 | 配置API名称。 API名称不允许重复。 默认为空，最大长度50字符，必填。 | |
| 描述 | 配置API描述。 默认为空，最大长度100字符，非必填。 | |
| 请求方法 | 请求方法。 当前支持 POST、GET 。 POST通过BODY传入参数，GET通过URL传入参数（QueryParam） 传入参数 QueryParam 时的参数说明如下：
| |
| 请求Body格式 | 请求方式选择POST时展示 选择请求的Body格式（其实就是请求Content-Type）：
默认选择「application/json」。 | |
| 路径 | 配置要发布的API路径。 API路径不允许重复。 默认为空，支持指定英文、数字、下划线（_）、连字符（-）、正斜杠（/）。 例如以下完整的API请求路径示例： http://192.168.5.175:8089/webroot/service/publish/应用ID/demo 注1：service前的部分为发布API所在的当前 FineDataLink 服务器地址。 注2：应用ID是API被绑定应用的ID，详情参见绑定API至应用。 | |
| 超时时间 | 填写响应超时时间，如果在指定时间后仍没有返回查询结果，则接口返回超时错误。 默认10000ms，必填。 | |
| 已授权应用 | 用户可在创建API时将其添加至授权应用，同时在API测试阶段可直接测试API调用情况。 同时可以将 API 任务批量添加至多个有权限的应用下。 详情请参见：绑定API至应用 | |
3.2 发布内容及参数
请求参数配置说明如下：
列表项目 | 说明 |
|---|---|
| 参数名 | 请求参数名。 参数名称不可重名。 默认为空，必填。 |
| 参数类型 | 请求参数类型。
注：对于日期类型参数标识为字符串，使用字符串形式传入，格式举例：【yyyy-MM-dd HH:mm:ss】 |
| 参数必填 | 配置当前参数是否必填。 如果没有勾选必填，则要求默认值配置项不能为空。 |
| 默认值 | 参数非必填时做非空校验 配置当前参数的默认值，参数配置为「非必填」时需要填写默认值。 当参数配置非必填，没有传参的情况下：取默认值作为参数值，默认值可以是对应类型的任何值，默认值可以为NULL。 注：参数是否必填，是针对实际API调用传参过程的，在进行预览和测试时，参数还是必须填完整。 |
| 描述 | 为参数添加描述。 默认为空。 |
3.3 预览测试
| 项目列表 | 说明 |
|---|---|
| API描述 | 选择测试API调用时使用的应用 如果没有绑定应用，则此配置灰化不可选。 |
| 调用测试 | 输入 Body 测试值或者 Params 测试值进行接口调试，测试调用情况。 |