Goku Plugin：Extra Params

插件名称	文件名.so	插件类型	错误处理方式	作用范围	优先级
额外参数	goku-extra_params	访问策略	继续后续操作	转发前	800

开启该插件后，不需要用户传某些参数值，网关会在转发时自动带上这些参数，支持header、body、query参数。 额外参数仅支持 表单 类型与 json 类型：

• formdata的参数值须为string类型，头部补充Conent-Type:x-www-form-urlencoded。
• 若额外参数是json类型，需在头部补充Content-Type:application/json。
• 参数类型为表单时支持同名参数。

目录

• 编译教程
• 安装教程
• 使用教程
• 更新日志

编译教程

环境要求

• 系统：基于 Linux 内核（2.6.23+）的系统，CentOS、RedHat 等均可；

• golang版本号：12.x及其以上

• 环境变量设置：

  • GO111MODULE：on

  • GOPROXY：https://goproxy.io

编译步骤

1.clone项目

2.进入项目文件夹，执行build.sh

cd goku-extra_params && chmod +x build.sh && ./build.sh

注：build.sh为通用的插件编译脚本，自定义插件时可以拷贝直接使用。

3.执行第2步将会生成文件： {插件名}.so

将该文件上传到节点服务器运行目录下的plugin文件夹，然后在控制台安装插件即可使用。

安装教程

前往 Goku API Gateway 官方网站查看：插件安装教程

使用教程

配置页面

进入控制台 >> 策略管理 >> 某策略 >> API插件 >> 额外参数插件：

配置参数

参数名	说明
params	额外参数列表
paramName	参数名
paramPosition	参数位置
paramValue	参数值
paramConflictSolution	参数冲突时的处理方式 [origin/convert/error]

参数冲突说明： 额外参数插件配置了参数A的值，但是直接请求时也传了参数A，此时为参数出现冲突，参数A实际上会接收两个参数值。

• convert：参数出现冲突时，取映射后的参数，即配置的值
• origin：参数出现冲突时，取映射前的参数，即实际传的值
• error：请求时报错，"param_name"has a conflict.

若paramConflictSolution为空，视为使用默认值convert。

配置示例

{
    "params": [
        {
            "paramName": "test",
            "paramPosition": "header",
            "paramValue": "extra_param",
            "paramConflictSolution":"convert"
        }
    ]
}

API请求参数

参数名	说明	必填	值可能性	参数位置
Strategy-Id	策略ID	是		header
Content-Type	数据类型	是	x-www-form-urlencoded 或 application/json	header

若该 test 参数为表单参数，则请求头部填写 Conent-Type:x-www-form-urlencoded。 若该 test 参数为Json参数，则请求头部需加 Conent-Type:application/json。