自定义请求

1. 简介

1.1 功能简介

自定义请求是指，基于现成的商业接口进行自定义配置，或根据自身需求封装接口，灵活地满足自身业务需求，从而实现接口取数、数据验证、数据分析、触发事件等一系列的操作。

1.2 应用场景

在阿里云/百度云等平台购买接口后，在简道云中使用接口时，需要通过前端事件中的自定义请求方法进行配置。

1.3 预期效果

以查询物流信息为例，自定义请求配置成功后效果如下所示：

2. 设置步骤

2.1 设置入口

在「前端事件 >> 执行动作」处的下拉框中选择「自定义请求」：

2.2 配置内容

2.2.1 请求类型

当触发字段值发生改变时，会自动触发 HTTP 请求，目前支持以下两种类型的请求：

2.2.2 URL

1）URL 是请求的服务器地址。当使用 GET 请求时，需要把参数放在 URL 中，同时可以插入字段给参数赋值。

2）URL 地址中，支持插入的字段以及对应的解析值格式如下：

2.2.3 Header/Body

两种参数的设置方法如下所示：

1） Header设置

每个 Header 参数设置中，都包含 name 和 Value 的设置。其中，Value 中可以插入表单字段，支持的字段同【3. URL】 处一致。

2）Body设置

根据调用接口的不同，Body 参数可以设置为 JSON 和 x-www-form-urlencoded 两种格式。

每个 Body 参数设置中，都包含 name 和 Value 的设置。其中，Value 中可以插入表单字段，支持的字段同【3. URL】 处一致。

2.2.4 返回值格式

返回值支持两种格式：JSON 和 XML，两种返回值格式对应的解析方式如下：

1）JSON Path

当返回示例如下时：

{
    "result": "result的内容",
    "testResult": {
        "target": "target的内容"
    },
    "data": [
        {
            "key": "扎啤",
            "value": "2"
        },
        {
            "key": "炸鸡",
            "value": "4"
        }
    ],
    "array": [
        "列表数据1",
        "列表数据2",
        "列表数据3",
        "列表数据4",
        "列表数据5"
    ]
}

对应返回值的 JSON Path 写法如下：

2）XPath

当返回示例如下时：

<results>
   <result>result的内容</result>
   <testResult>
       <target>target的内容</target>
   </testResult>
   <data>
       <key>扎啤</key>
       <value>2</value>
       <key>炸鸡</key>
       <value>4</value>
   </data>
   <array>列表数据1列表数据2列表数据3列表数据4列表数据5</array>
</results>

对应返回值的 XPath 写法如下：

2.2.5 返回值设置

返回值设置是指，将前端事件获取的数据赋值给表单字段。

1）点击返回值设置下方的「点击设置」：

2）点击「表单字段及对应返回值」，在下拉框中选择需要设置返回值的字段：

3）对返回值字段中配置赋值规则，可以直接赋值，也可以插入表单中的字段进行赋值：

4）支持设置返回值的字段及其对应的解析值格式如下：

5）子表单填充方式

若在「添加表单字段及对应返回值」处选择了子表单中的字段，则需要同步设置子表单字段的填充方式。目前，简道云支持以下两种子表单字段填充方式：

以物流信息查询为例，直接填充到对应子字段和先清空子表单再填充的效果如下所示：