数据源配置
打通各类型数据源和数据服务平台之间的网络链路,将数据源注册到数据服务平台 > 数据源模块。
- 登录 DataLeap控制台。
- 进入数据服务 > 数据源界面,进行新建数据源操作。各数据源配置详见“创建数据源”。

创建物理表
物理表是在线存储引擎中(如MySQL/Doris等数据库)中的一张表。
服务每次查询运行都需要使用物理表的元数据构造DSL,因此目前将存储中表/字段信息注册到数据服务平台中以方便查看和管理。
在数据源创建完成后,切换至物理表管理界面,进行物理表创建。更多详细物理表相关操作,详见“物理表管理”。

创建逻辑表
逻辑表是数据开发者在平台进行逻辑建模后产生的虚拟表,是物理表的一个映射。
通过逻辑表屏蔽底层存储细节,完成物理表字段类型转换、规范命名、备份容灾配置等。用户实际配置API时必须使用逻辑表,不支持直接使用物理表。
- 事先已创建成功物理表。
- 在逻辑表管理界面,进行新建逻辑表。
- 依据已创建的物理表,创建相应的逻辑表。更多详细逻辑表相关操作,详见“逻辑表管理”。

创建API
API目前支持脚本式/向导式/原生式三种类型,可根据实际需要进行API的创建选择。
- 脚本式:支持自行编写API的查询SQL,该方式可满足高阶需求,支持选择同源多张逻辑表进行处理;
- 向导式:无需代码编写,在界面勾选配置即可快速生成API(仅支持单张逻辑表);
- 原生式:支持用户灵活查询数据集的一种Query,目标是对在圈选范围内逻辑表进行灵活的重组查询,适合数据分析面板类场景。
- 指标查询式:指标查询式API,可将指标平台中的指标查询整合到数据服务平台中,通过数据服务指标查询API开发,开发人员可更高效地查询指标服务中的指标信息。
更多详细操作详见“API开发”。

开发API
可基于逻辑表快速表生成API,供服务应用系统调用API获取数据。如SQL中与选择逻辑表不一致,会导致查询出错。
- 逻辑表选择:
- 脚本式:支持绑定同源的多张逻辑表进行开发。
- 向导式:仅支持单个逻辑表进行开发。
- 原生式:支持绑定同源的多张逻辑表进行开发。
- 编辑查询SQL编辑(脚本式)、请求/返回参数设置(向导式),其中脚本式的请求/返回参数,均可通过SQL自行解析来输入。
- 高级配置中,完成数据缓存时间设置,用于设定服务查询对结果集的缓存时间。
更多开发API操作可详见“开发API”。

测试API
API开发配置完成后,您可通过测试能力,来查看API的逻辑是否正确。操作详见“测试API”。

上线API
API测试无误后,您可将API发布至线上环境或测试环境,以便您在不同环境中进行调用。详见“发布API”。

授权应用
API目前不针对个人授权,只针对应用授权,如某个应用需调用API,需先完成授权才可进行调用。
- 应用需先在系统管理 > 应用管理中完成注册。创建应用操作,详见“应用管理”。
- 进入API详情界面,在授权管理页签中,对创建的应用完成授权操作。

调用 API
API发布线上环境后,您可在API详情中,获取调用地址信息,请求代码示例,请求/返回参数等信息,您也可以直接在界面生成接口文档,供您调用参考。详见“API调用”。
