数据服务

数据服务

使用场景：用户需通过界面化配置快速生成API服务资产，并提供消费。

使用角色：数据开发人员。

功能描述：平台提供数据服务快速构建能力，支持配置服务基本信息，请求和返回参数后，快速生成API服务资产。

新建

进入数据开发 > 数据服务界面，点击界面上方的“新建数据服务”按钮，在新建页面中填写相关信息后“保存”即可。

• API基本信息配置
  • 名称：必填，用户根据实际业务场景手动输入数据服务名称，支持中英文，空间内不允许重复；
  • 提供方：必填，下拉选择组织机构，即该数据服务的来源组织；
  • 责任人：必填，必填，下拉选择用户作为该复合指标责任人，当前仅为业务层面责任人，不会进行相关权限校验；
  • 资源标签：非必填，可多选自定义资源标签；
  • 关联目录：非必填，点击按钮后可勾选多个目录进行关联目录，可用于后续按目录检索及数据开放按目录展示；
  • 参考依据：非必填，可多选，下拉选择已发布标准文件名称，后续查看指标时可下载标准文件；
  • 描述：非必填，用户可以根据实际业务场景或数据服务创建用途等信息填写；
  • 协议：HTTP，不可修改；
  • 请求方式：POST，不可修改;
  • 返回类型：JSON，不可修改；
  • API Path：由系统自动生成；
  • 调用频率上限：必填，用户根据实际业务需求手动输入，限制API在一段时间内所有用户的最大调用频次，当前支持分钟级别限制，超过上限则API停止响应，直至下一分钟自动恢复，最大上限10000。

• API参数配置

  • 类型：必填，点击下拉框可选择“数据表”或者“主数据”；

  • 数据表：必填，点击下拉框可选择“数据表”或者“主数据”对应的表，不可选择无权限数据表，不可选择其他空间授权的跨空间数据表；

  • 返回结果分页：默认关闭，无分页最多返回2000条数据；可手动开启，若所选数据表无主键或索引，不允许开启，开启后请求参数、返回参数均会自动新增分页相关公共参数；

  • 排序：设置后返回数据时会按照排序规则进行数据记录排序。

    注意

    • 未开启分页，排序非必填，开启分页，则排序必填；
    • 排序字段仅可选择主键、索引字段；
    • 每个字段可配置独立的排序方式，默认升序，可选择降序；
    • 支持添加多个排序字段，排序顺序按从上至下所选字段进行联动排序。

  • 行级过滤：非必填，支持通过指定字段和字段值来限制数据范围，若有多个指定字段值，则所有指定字段值的关系为“且”。

  • 请求参数：非必填，支持选择来源表字段，不可选择无权限字段，并配置参数名、操作符、是否必填等信息；若开启“返回结果分页”，则自动添加公共参数，公共参数无需配置，不可删除；

  • 返回参数：必填，支持选择来源表字段，不可选择无权限字段，并配置参数名，至少需选择一个返回参数，或批量将所有字段添加为返回参数；返回参数存在公共参数，无需配置，不可删除。

  

  

  • 请求参数操作符说明：

  操作符	逻辑	示例
  =	等于	如获取名字恰好是"张三"的用户，GET /api/users?name=张三
  !=	等于	如获取除"张三"以外所有的用户列表，GET /api/users?name!=张三
  <	小于	如获取年龄小于20岁的用户列表，GET /api/users?age<20
  <=	小于等于	如获取年龄小于等于20岁的用户列表，GET /api/users?age<20
  >	大于	如获取年龄大于20岁的用户列表，GET /api/users?age>20
  >=	大于等于	如获取年龄大于等于20岁的用户列表，GET /api/users?age>=20
  IN	属于集合中的某一个	如获取ID为1、3或5的用户
  NOT_IN	不属于集合中的任何一个	如获取除了ID为1、3或5之外的所有用户
  NOT_LIKE	不符合模糊匹配条件	如获取所有邮箱不以"qq.com"结尾的用户
  BETWEEN	在两个值之间（包含这两个值）	如获取年龄在20到30岁之间的用户

修改

进入数据开发 > 数据服务界面，点击数据服务列表操作列的“修改”按钮，即可修改数据服务所有信息。

注意

• 未发布的数据服务方可修改；
• 若修改数据服务来源表，则下方请求参数、返回参数均需重新配置。

在线测试

进入数据开发 > 数据服务界面，点击查看数据服务，切换至“在线测试”标签页，可通过输入各参数值进行在线测试，以验证数据服务是否配置正确，及返回结果是否符合预期。

• 请求参数：可根据需要填写测试值，需保证所有必填参数均填写测试参数值；
• 返回条数：默认10条，可修改，最大100条；
• 请求详情：自动根据请求内容生成实际请求体；
• 返回内容：展示根据测试请求参数返回的实际数据。

发布&下架

平台提供发布/下架和批量发布/下架两种操作，进入数据开发 > 数据服务界面，可按需选择对应操作按钮。

注意

• 数据服务发布后，且所在目录也已发布，则可在数据开放 > 本空间资产 > 数据服务资产模块查看并消费；
• 数据服务发布后不允许修改、删除操作，需下架后再进行修改、删除。

关联目录&解除关联

• 关联目录
  平台支持将资产关联至目录，供后续资产发布至数据开放模块时，若关联目录也发布，则可按目录展示资产。

1. 点击某个资产“关联目录”按钮；或批量勾选资产后，点击“批量关联目录”按钮。
2. 进入 “关联目录” 操作界面后勾选需要关联的“待选”目录，将其确认为“已选”目录，保存即可关联目录。

注意

• 已发布资产不允许关联目录，需下架资产再操作；
• 一个指标可关联多个目录，当前表已选目录不可重复选择；
• 批量关联时不会显示多个表的已关联目录，并且保存后会清空各表已关联目录，仅关联最新批量选择的目录。

• 解除关联
  已关联目录的资产支持解除关联，则该资产不可在数据开放模块可见。

1. 点击某个资产“关联目录”按钮，即可解除关联目录。
2. 进入 “关联目录” 操作界面后将需要解除关联的“已选”删除，保存即可解除关联目录。

注意

• 已发布资产不允许解除关联目录，需下架资产再操作；
• 当前暂不支持批量解除关联目录。

删除

进入数据开发 > 数据服务界面，点击数据服务列表操作列的“删除”按钮，二次确认后即可删除数据服务。

注意

• 未发布的数据服务方可删除。