跳到主要内容

数据服务开发

业务场景

用户将“学生成绩表”构建为数据服务,并通过数据服务开发定义固定的请求参数和返回参数,消费用户可通过学生的基本信息作为请求,从而获取到学生成绩信息,达到查询成绩的效果。

前提条件

  • 平台部署完毕,数据开发服务正常;
  • 用户拥有数据服务模块权限

使用限制

  • 数据服务仅支持HTTP协议,请求方式仅支持POST,返回类型仅支持JSON
  • API Path由系统生成,暂不支持自定义

操作流程

第一步:准备数据表

资源管理 > 数据表管理 > 全仓数据表管理界面,确保该页面已有数据服务所需来源表,且表中数据正确。若无所需数据表,可通过新建表并导入数据,或批量数据加工完成数据表及数据的准备。本实践中以提前准备好所需的学生成绩表。 最佳实践

第二步:新建数据服务

1)在数据开发 > 数据服务页面中点击“新建数据服务”,在新建页面完成配置数据服务基础信息配置。
最佳实践

2)参数配置:需选择来源表,并按需配置结果分页、排序、行级过滤,同时配置请求参数、返回参数。本实践中,学生成绩查询需要输入学生编号和姓名作为请求,然后返回指定学生的各科成绩,则具体配置如下图所示,更多细节配置可查看数据服务介绍。
数据服务 数据服务

注意
  • 若不配置结果分页,最多返回2000条数据。

3)在线测试:数据服务保存后,点击查看数据服务,切换至“在线测试”标签页,可通过输入各参数值进行在线测试,以验证数据服务是否配置正确,及返回结果是否符合预期。 数据服务

第三步:数据服务消费

1)在数据开发 > 数据服务页面中可以看到与刚刚创建的数据服务,此时可以关联已发布的目录并将数据服务发布至数据开放模块。 数据服务

2)在数据开放 > 本空间资产 > 数据服务资产中可查看已发布的数据服务,以供所需用户进行申请消费。更多开放使用配置可查数据服务资产介绍申请访问。
最佳实践