[]
        
在线Demo 免费试用
(Showing Draft Content)

连接网络型JSON时使用参数

1. 概述

1.1 功能概述

Wyn支持连接网络型JSON时使用参数,对接入的数据进行加工和处理,最终通过仪表板或报表实现数据的可视化展示。

1.2 应用场景

当您需要通过参数动态过滤网络型JSON数据,并将其数据接入 Wyn,借助 Wyn 强大的可视化图表与报表功能进行数据展示时,本文将为您详细介绍从参数配置到数据接入 Wyn 的具体操作流程,为您提供全面且实用的参考。

在与网络型 JSON 数据源对接中,支持在以下配置项中使用参数,实现动态数据过滤。

具体支持使用参数的配置项有:

  • 基准地址或端点地址中。

  • 请求头中,全局请求头,有效载荷中。

    引用参数时,需使用 @ 符号。例如,若参数为 P1,则通过 @P1 引用。

type=info

注意

我们在连接网络型 JSON 数据源时,有两种参数:

  • 基准地址参数:在基准地址及所有下属端点地址中有效,也就是说基准地址参数可以在当前基准地址及下属端点地址中所有可使用参数的配置项中使用。

  • 端点地址参数:仅在当前端点地址中有效,也就是说端点地址参数仅在端点地址内部的配置项中使用。两者的用法相同,但作用范围不同。

本文将以一个全局参数为例,展示参数的使用过程。

2. 操作步骤

2.1 前提条件

使用参数动态过滤网络型JSON数据源前,需满足以下条件:

  1. 接口准备:提前准备好支持参数配置的网络型 JSON 数据源。

type=info

提示

在报表中使用直连数据集,连接带参数的 JSON 数据源时,仅支持单个基准地址的情况。

2.2 操作步骤

步骤一: 创建数据源并添加参数

  1. 在基准地址中添加一个基准地址参数,设置参数名称、数据类型和默认值(预览或使用时可更改此值)。

    image

    PixPin_2025-02-24_10-38-11

步骤二:使用参数

  1. 在基准地址或端点地址中,使用 ?@ 符号连接和引用参数。

    以下示例将参数应用到端点地址中:

    image

  2. 在端点地址中使用参数过滤数据(如 userId):

    PixPin_2025-02-24_10-41-23

  3. 完成端点地址配置并验证成功:

    image

步骤三:预览数据

  1. 预览数据,确保配置正确:

    PixPin_2025-02-24_10-49-05

    PixPin_2025-02-24_10-51-19

步骤四: 保存

  1. 预览无误后,单击页面右下角的创建,保存Json数据源。

    PixPin_2025-02-24_10-55-04

    type=info

    提示

    当有多个参数时,多个参数之间使用 & 符号连接。例如:

    image

步骤五:文档门户查看数据

  1. 数据源保存后,可在文档门户进行预览查看。点击该数据源会弹出参数输入框,显示参数默认值,也可以更改参数值然后进行预览。

    PixPin_2025-02-24_10-57-06

  2. 例如,将参数值修改为了 4,则仅返回 userId4 的数据:

    PixPin_2025-02-24_10-59-07

步骤六:使用

  1. 使用带参数的 JSON 数据源创建数据集后,会自动添加数据源参数,如下图所示,您也可以修改过滤值。

    PixPin_2025-02-24_11-00-57

  2. 在直连数据集中,可将参数与数据源参数绑定,实现动态数据过滤:

    PixPin_2025-02-24_11-05-01

3. 多值参数

JSON 数据源支持多值参数,但默认值只能用逗号,分隔。

例如,我们将上例中的基准地址参数开启多值,并设定默认值为2,4

PixPin_2025-04-16_10-25-11

  • 分隔符

    • 作用:用来设定多值参数在URL中拼接时的字符。

      分类

      含义

      默认情况

      默认为空,会被解析为& 符号并重复过滤参数,如 “userId=2&userId=4”。

      自定义分隔符

      当您填入其他符号时,则会使用填入的符号直接拼接多值内容,如“userId=2-4”。

  • 以下为示例:

    使用默认分隔符时,请求内容如下:

  1. 单击页面右侧的请求预览,查看请求内容。

    PixPin_2025-02-24_11-06-54

  2. 可见多值参数在 URL中使用& 符号拼接,并且重复了参数内容。

    PixPin_2025-02-24_11-08-27

  3. 此时预览数据,效果如下,将 userId=2 和 userId=4 的对应数据全部过滤。

    PixPin_2025-02-24_11-09-34

    综上,分隔符的用法:当不填写分隔符时,发出的请求会使用&符号拼接,并重复参数,但是当填入分隔符时则使用填入的符号直接拼接默认值。

type=info

注意

多值参数仅在 URL 中使用以上分隔符拼接规则。如果用在其他地方,比如请求头和有效载荷中时,不论分隔符填写什么,多值参数都只会被解析成数组进行传递。如[2,4]。

image2021-11-8_18-6-9.png

4. 注意事项

4.1 URL查询字符串对参数值的编码

当参数用于 URL 查询字符串(也即URL中?之后的部分)中时,参数值会进行 URL 编码。可通过请求预览查看最终发出的 URL 请求内容。比如 “=” 会被编码成 “%3D”。

以下为示例:

  1. 参数p2用于URL的?之前,p1用于之后:

    PixPin_2025-02-24_11-36-01

  2. 单击请求预览,预览实际发出的请求内容。

    PixPin_2025-02-24_11-31-55

  3. 可见,p2 的参数值并未编码,还保持为 %3D,而 p1 的参数却经过了 URL 编码,==编码为了%3D%3D

    image2022-2-9_11-18-25.png

    type=info

    建议

    在设计参数值时,请考虑URL编码问题,并通过预览功能验证最终URL是否符合预期效果。