数据服务平台主要帮助用户将存储中的数据(如某张 MySQL 数据表)快速封装成一个可供服务端消费的 API 接口,并提供此 API 接口的管理、运维和共享能力。
需求背景:
某个产品页面上需要新增展示登录用户最近 7 天访问次数,需要服务端研发同学提供近 7 天访问次数的接口给前端同学,数据存储在 MySQL 中。
使用数据服务平台如何完成?
先加工好数据,写入到 MySQL 存储中,此时在数据服务平台 > 数据源管理模块中,完成 MySQL 表(物理表)的接入和逻辑建模(创建基于 MySQL 表的逻辑表),再在 API 模块使用逻辑表配置、调试、发布 API,并授权给自己的应用(PSM)。后续此 API 的更新、权限变更、运维等操作,均可以在数据服务平台完成。
在进行数据服务的 API 开发前,您需做以下准备工作。
创建业务线
租户管理员需要先到数据服务 > 系统管理 > 业务线管理模块中,创建业务线。详见业务线管理。
创建项目
租户管理员或业务线管理员需到数据服务 > 系统管理 > 项目管理模块中,创建项目。详见项目管理。
添加账户权限
添加数据服务角色,为 API 开发人员添加相应的权限。详见账户权限管理。
网络配置
不同网络环境,您可根据实际情况进行公网、VPC 相关网络配置。详见网络配置。
数据服务主要流程如下:
打通各类型数据源和数据服务平台之间的网络链路,将数据源注册到数据服务平台 > 数据源模块。
登录 DataLeap租户控制台。
进入数据服务 > 数据源界面,进行新建数据源操作。各数据源配置详见创建数据源。
物理表是在线存储引擎中(如 MySQL/Doris 等数据库)中的一张表。
服务每次查询运行都需要使用物理表的元数据构造 DSL,因此目前将存储中表/字段信息注册到数据服务平台中以方便查看和管理。
在数据源创建完成后,切换至物理表管理界面,进行物理表创建。更多详细物理表相关操作,详见物理表管理。
逻辑表是数据开发者在平台进行逻辑建模后产生的虚拟表,是物理表的一个映射。
通过逻辑表屏蔽底层存储细节,完成物理表字段类型转换、规范命名、备份容灾配置等。用户实际配置 API 时必须使用逻辑表,不支持直接使用物理表。
事先已创建成功物理表。
在逻辑表管理界面,进行新建逻辑表。
依据已创建的物理表,创建相应的逻辑表。更多详细逻辑表相关操作,详见逻辑表管理。
API 目前支持脚本式/向导式/原生式三种类型,可根据实际需要进行 API 的创建选择。
脚本式:支持自行编写 API 的查询 SQL,该方式可满足高阶需求,支持选择同源多张逻辑表进行处理;
向导式:无需代码编写,在界面勾选配置即可快速生成 API(仅支持单张逻辑表);
原生式:支持用户灵活查询数据集的一种Query,目标是对在圈选范围内逻辑表进行灵活的重组查询,适合数据分析面板类场景。
更多详细操作详见 API 开发。
可基于逻辑表快速表生成 API,供服务应用系统调用 API 获取数据。如 SQL 中与选择逻辑表不一致,会导致查询出错。
逻辑表选择:
编辑查询 SQL 编辑(脚本式)、请求/返回参数设置(向导式),其中脚本式的请求/返回参数,均可通过 SQL 自行解析来输入。
高级配置中,完成数据缓存时间设置,用于设定服务查询对结果集的缓存时间。
更多开发 API 操作可详见开发 API。
API 开发配置完成后,您可通过测试能力,来查看 API 的逻辑是否正确。操作详见测试 API。
API 测试无误后,您可将 API 发布至线上环境或测试环境,以便您在不同环境中进行调用。详见发布 API。
API 目前不针对个人授权,只针对应用授权,如某个应用需调用 API,需先完成授权才可进行调用。
应用需先在系统管理 > 应用管理中完成注册。创建应用操作,详见应用管理。
进入 API 详情界面,在授权管理页签中,对创建的应用完成授权操作。
API 发布线上环境后,您可在 API 详情中,获取调用地址信息,请求代码示例,请求/返回参数等信息,您也可以直接在界面生成接口文档,供您调用参考。详见 API 调用。