全局配置

概述

    在白码平台的全局配置中可以设置系统的全局变量，即可在功能编程、API编程或者步骤字段中使用该变量。优点是若多个功能或API使用的某个变量值都相同且可能会同时需要修改，例如调用api时所需要的配置秘钥等变量，即可使用全局变量，达到方便维护的作用。

基本操作

1.在白码平台端打开系统设置->高级配置->全局配置。

2.点击新增并修改键和值，也可以编辑该变量的描述或者是否加密。

    加密后该变量值将不显示，在配置一些接口的配置项时，例如支付宝商家密钥等配置值，一般使用该加密功能，使一些需要保密的数据更为安全。

3.新增全局变量，如图即为示例的全局变量。

编程步骤中使用全局变量

编程获取全局变量代码：

代码如下:         复制代码

//获取全局配置（KEY）
await $modules.share.get("$$CONFIG@KEY")

1.创建编程步骤。

2.点击编程步骤进行编辑代码。

代码如下:         复制代码

async function runProcess($model = model,$plugin = plugin,$params = params){
    let query = await $plugin.share.get("$$CONFIG@QUERY");//@后面即为刚才创建的键，QUERY就是刚才创建的键名；定义变量query获取全局变量的值
    $model.log(query);//调试输出该变量的值
}

3.测试功能，查看调试结果。

API编程中使用

一、API配置中使用全局变量

    该使用场景一般在调用外部api时需要，一般是需要一些配置项，如图所示value的值使用代码$$CONFIG@KEY来获取全局变量

1.在白码平台端打开API配置，创建API示例。

2.打开API，编辑API配置内容。

二、API编程中使用全局变量

API中获取全局变量代码：

代码如下:         复制代码

//获取全局配置（KEY）
await $modules.share.get("$$CONFIG@KEY")

1.在白码平台端打开API配置，创建API示例。

2.打开API，编辑API编程内容。

代码如下:         复制代码

async function run($input,$output,$modules = modules){
    let secret = await $modules.share.get("$$CONFIG@SECRET")//@后面即为刚才创建的键，SECRET就是刚才创建的键名；定义变量secret获取全局变量的值
    $output.data = {
        "result":secret
    }
}

3.点击调试，点击测试，查看API调试结果。

三、步骤字段中也可引用全局变量

    和编程的写法一样，$$CONFIG@HOST，HOST为全局配置中的变量名，这样在功能步骤的设为中依然可以获取到全局变量