跳到主要内容

自定义数据源

自定义数据源是指在系统中通过配置和管理外部数据源或静态数据源，以便前端页面能够通过调用这些数据源来获取所需的数据。这种方式使得前端能够从不同的数据来源（如外部API、静态文件等）获取数据，提升了数据的灵活性和可扩展性。

下面是对添加外部数据源和静态数据源的详细描述。

外部数据源​

外部数据源通常指的是系统以外的、由其他服务或平台提供的数据来源，通常通过网络请求（如HTTP请求）获取数据。这些数据源可能是外部API、Web服务、或者是与第三方系统进行集成的接口。

右键点击项目节点，选择 自定义数据源。在 数据源/API 窗口的左边 外部API 类别中点击 +添加 图标。

image-20250625142657478

或者点击窗口中央的 添加外部数据源，然后指定以下信息：

  • 名称：为该外部数据源指定一个唯一的标识名称，便于在平台中管理和引用。
  • URL：外部数据源的接口地址。通常是一个HTTP或HTTPS链接，系统会通过这个URL向外部数据源发起请求并获取数据。

示例：

假设你要添加一个外部数据源，用于从一个外部API获取用户数据：

名称：UserDataAPI

URL：https://api.example.com/getUserData

image-20250625142303799

系统还支持通过导入符合 OpenAPI 协议的 URL 或数据文件，快速创建和配置外部数据源。该功能可自动识别接口结构、请求方式及参数定义，极大简化手动配置的步骤，适用于对接标准 RESTful API 服务。

在 数据源/API 窗口的左边 外部API 类别中点击 导入 图标。

image-20250625142818438

填入符合 OpenAPI 规范的文档地址或上传 JSON/YAML 格式的数据文件，系统将自动解析并生成对应数据源结构。

image-20250625142912599

添加外部数据源后，可以添加请求参数和指定返回结果的数据类型，确保系统能够正确地与外部服务进行交互。

  • 请求参数：用于向外部数据源发送请求时传递的各种参数。你可以指定参数的名称、数据类型、来源（Query、Route、Header）等, 确保数据请求符合外部API的要求。
  • 返回结果的数据类型：指定外部数据源返回的数据类型。它可以帮助系统正确解析和处理从外部数据源（如API、Web服务等）获取的响应数据。

以下是关于请求参数设置的详细描述：

  • 名称：请求参数的名字，用于标识该参数。例如，外部API可能需要一个名为userId的参数来查询某个用户的数据，或者需要一个dateRange来限定数据的时间范围。参数名称必须与外部API的要求保持一致。

  • 数据类型：指定请求参数的数据类型。

  • 来源：指定请求参数来源的方式。通常有以下几种:

    • Query：参数通过查询字符串附加在URL中，例如 https://api.example.com/data?userId=123 。这种方式用于GET请求。
    • Route：参数作为路径的一部分传递。例如 https://api.example.com/data/123 ，这里的123就是路径参数，代表userId。
    • Header：参数作为HTTP请求的头部传递，用于发送一些身份验证信息、API密钥、用户代理等。例如，Authorization: Bearer <token>.

    示例:

    Query：https://api.example.com/data?userId=123&startDate=2023-01-01

    Route：https://api.example.com/data/123，其中 123是 userId。

    Header：在HTTP头部添加 Authorization: Bearer <token>来进行身份验证。

image-20250626111552407

在系统中配置这个外部数据源后，前端可以通过该配置进行API调用，获取用户数据并展示到页面上。

静态数据源​

静态数据源通常指的是不依赖外部服务或接口的数据源，数据是预先定义和存储在平台中的，比如JSON文件或硬编码的静态数据。这些数据不随时间或外部服务变化，而是固定的，通常用于提供某些常见的、无需动态获取的静态信息（如常见的下拉框选项、配置项等）。

右键点击项目节点，选择 自定义数据源。在 数据源/API 窗口选择 静态数据 选项卡，点击 +添加 图标，然后指定以下信息：

  • 名称：为静态数据源指定一个唯一的名称，用于在平台中识别。

  • 分组：为静态数据源分组，便于管理。

  • 数据类型：指定静态数据源的数据类型。常见的数据类型有:

    • 数据结构：静态数据源可以是一个数据结构（如对象或数组），这些数据会在系统内部定义，并可能会被前端直接引用。比如，你可能有一个静态数据源，它包含了一些固定的国家列表，每个国家有 Name 和 code 属性。
    • 数据字典：数据字典通常是键值对的数据集合，用于为某些字段提供固定选项。比如，你可能有一个“状态字典”静态数据源，包含“待审核”、“已批准”、“已拒绝”等选项。

  • JSON数据：当指定为数据结构类型时，你需要提供具体的静态数据（通常是JSON格式的数据）。

示例：

假设你要添加一个静态数据源，包含国家列表：

名称：CountryList

数据类型：数据结构

JSON数据：

[
{ "Code": "CN", "Name": "China" },
{ "Code": "US", "Name": "United States" },
{ "Code": "IN", "Name": "India" },
{ "Code": "GB", "Name": "United Kingdom" }
]

这个静态数据源将提供一个国家列表，前端页面可以通过调用这个数据源来填充下拉框，提供用户选择。

image-20250625150152220