文档首页/ 工业数字模型驱动引擎/ 数据建模引擎用户指南/ UI引擎使用指南/ 创建与管理UI引擎数据源/ 创建与管理第三方API服务数据源的API集合
更新时间：2025-12-30 GMT+08:00
查看PDF
分享

创建与管理第三方API服务数据源的API集合

UI引擎支持为第三方API服务数据源中的单条API生成数据集合。该集合通过定义API的参数结构与映射关系，可在UI引擎前端项目“页面设计器”中直接关联数据源组件，快速生成表单、表格等业务所需的页面元素，大幅提升产线数据看板、设备台账等页面的搭建效率。

数据集合不仅实现了API参数的统一管理，还简化了数据源组件与API之间的数据绑定流程，确保组件能够准确解析并展示API返回的业务数据。

用户可在UI引擎在对数据集合进行“创建”、“编辑”、“删除”等全生命周期管理操作，灵活调整配置，满足不同阶段的业务需求。

前提条件

进入第三方API服务数据源API的集合管理页

  1. 在左侧导航栏中，单击“UI引擎”，进入“UI引擎”。
  2. 在左侧导航栏中，选择“数据源管理”，进入“数据源管理”页面。
  3. 在“数据源管理”页面，选择“第三方API服务”，右侧数据源列表展示所有已创建的第三方API服务数据源。
  4. 找到目标数据源，单击，展开该数据源的“API管理”页面。

    图1 第三方API服务

  5. 找到目标API，在对应行“操作”栏中单击，展开“编辑API”页面。
  6. 切换至“集合管理”页签，即可对该API的集合进行创建、编辑、删除等操作。

基于第三方API服务数据源的API创建集合

  1. 进入第三方API服务数据源API的集合管理页。
  2. 在“集合管理”页签下，单击“新增”，弹出“新增集合”窗口。

    图2 新增集合

  3. 在弹出的窗口中，根据实际业务需求，设置如下信息。

    图3 设置集合
    表1 新增集合配置信息

    参数名称

    参数说明

    集合名称

    填写此集合的名称，建议清晰描述其用途、对应业务模块等信息，便于后续管理与识别。

    长度限制为1-255个字符。

    参数

    根据接口业务需求，单击“新增”可添加一个或多个字段，用于将API的特定参数映射为集合中的字段。每个字段包含以下属性：

    • 字段标识：从下拉列表中选择API中已定义的参数。支持“path参数”、“query参数”、“body参数”、“response参数”四种类型。已选的字段标识不可重复，列表中对应项将被置灰。
    • 字段名称：字段的友好展示名称，用于页面设计器中直观识别字段含义。长度限制为1-255个字符。
    • 映射值：字段在数据平铺后的最终映射键名，系统默认格式为“参数位置_参数各父级参数名_当前参数名”。长度限制为1-255个字符，且在集合内不可重复。
    • 位置：字段在API中的原始参数位置（如path、query等），与API定义一致，不可修改。
    • 类型：字段对应的数据类型，包括“字符串 (string)”、“32位整型 (int32)”、“64位整型 (int64)”、“整型 (integer)”等类型，不可修改。
    • 父节点类型：当前字段父节点的数据类型，仅包含数组 (array)、对象 (object) 两种，不可修改。

  4. 单击“确定”。

编辑API集合

支持对已创建的API集合参数进行修改，适配业务需求的变更。

  1. 进入第三方API服务数据源API的集合管理页。
  2. 找到目标集合，在对应行“操作”栏中单击，弹出“编辑集合”窗口。

    图4 编辑集合

  3. 在弹出的窗口中，根据实际业务需求修改信息，单击“确定”。

删除API集合

支持对无用的API集合执行单个或批量删除操作，释放配置资源。

  1. 进入第三方API服务数据源API的集合管理页。
  2. 在“集合管理”页签下，您可以通过如下方式删除集合。

    • 单个删除：在待操作的集合所在行，单击。
      图5 单个删除
    • 批量删除：勾选多个集合，单击列表上方的“批量删除”。

      单次批量删除最多支持10条集合数据。

      图6 批量删除

  3. 在弹出的提示框中，单击“确定”。

相关文档