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

管理第三方API服务的API

本文档介绍如何对第三方API服务数据源下的API进行统一管理，帮助用户实现接口的规范化管控。

前提条件

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

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

    图1 第三方API服务

编辑某个API详情

用户可以对已导入的API参数进行编辑，以满足实际业务需求。

  1. 进入第三方API服务数据源的API管理页。
  2. 找到目标API，在对应行“操作”栏中单击，展开“编辑API”页面。
  3. 在“API页签”下，根据实际业务需求修改API的相关信息，单击“保存”。

    表1 编辑API详情配置信息

    参数

    参数说明

    API名称

    支持自定义修改。

    长度不超过255个字符。

    路径参数

    对应API“方法路径”（如“/path/{curPage}/{pageSize}”）中的动态参数。配置规则如下：

    • 参数名：不可修改，不可重名，长度不超过128个字符。
    • 参数类型：支持修改，可设置为“字符串 (string)”、“32位整型 (int32)”、“64位整型 (int64)”或“整型 (integer)”。
    • 描述：用于解释参数含义（如当前页码、每页条数），长度不超过256个字符。
    • 是否必填：默认必填，不可修改。

    查询参数

    对应API的Query参数，支持新增、修改与删除。

    • 父级：仅可选择“数组 (array)”或“对象 (object)”类型参数，支持5级层级，可选父级最大层级为4级。
    • 参数名：不可重名，长度不超过128个字符。
    • 参数类型：可选9种类型，包括：字符串 (string)、32位整型 (int32)、64位整型 (int64)、整型 (integer)、双精度浮点数 (double)、日期时间 (date-time)、布尔 (boolean)、数组 (array)、对象 (object)。其中，“数组 (array)”与“对象 (object)”仅可互相转换，其他7种类型可任意转换。
    • 描述：用于解释参数含义，长度不超过256个字符。
    • 是否必填：支持自定义配置。

    请求体参数

    对应API的Body参数，支持新增、修改与删除。

    • 父级：仅可选择“数组 (array)”或“对象 (object)”类型参数，支持5级层级，可选父级最大层级为4级。
    • 参数名：不可重名，长度不超过128个字符。
    • 参数类型：可选9种类型，包括：字符串 (string)、32位整型 (int32)、64位整型 (int64)、整型 (integer)、双精度浮点数 (double)、日期时间 (date-time)、布尔 (boolean)、数组 (array)、对象 (object)。其中，“数组 (array)”与“对象 (object)”仅可互相转换，其他7种类型可任意转换。
    • 描述：用于解释参数含义，长度不超过256个字符。
    • 是否必填：支持自定义配置。

    响应体参数

    对应API的响应参数，可以进行新增、修改与删除。

    • 父级：仅可选择“数组 (array)”或“对象 (object)”类型参数，支持5级层级，可选父级最大层级为4级。
    • 参数名：不可重名，长度不超过128个字符。
    • 参数类型：可选9种类型，包括：字符串 (string)、32位整型 (int32)、64位整型 (int64)、整型 (integer)、双精度浮点数 (double)、日期时间 (date-time)、布尔 (boolean)、数组 (array)、对象 (object)。其中，“数组 (array)”与“对象 (object)”仅可互相转换，其他7种类型可任意转换。
    • 描述：用于解释参数含义，长度不超过256个字符。
    • 是否必填：支持自定义配置。

    响应体参数支持两种类型：

    • array：响应数据为数组格式。
    • object：响应数据为对象格式。

删除API

支持对已导入的API进行单个或批量删除操作，确保数据源管理的灵活性。

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

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

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

      图3 批量删除API

  3. 在弹出的窗口中，根据界面提示输入指令，单击“确定”。

查询API

默认情况下，API管理页面会展示当前第三方API服务数据源下的全部已导入API。为了帮助用户快速定位目标API，支持通过“API名称”和“方法路径”等属性维度进行筛选。

图4 查询API

相关文档