文档

上传插件

更新时间:

您开发的插件可以通过发布插件的方式上传到插件市场。只有当前主账号或具有云原生API网关权限的子账号可以看到并使用该插件。插件启用方式和平台提供插件一致。

操作步骤

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择插件市场

  3. 插件市场页面的右上角单击发布插件

  4. 发布插件面板,填写插件参数信息,单击上传,等待插件发布成功(此过程可能需要30秒左右)。

    参数

    描述

    选择语言

    选择编写插件时使用的开发语言。

    插件标识

    设置插件的英文标识(唯一标识)。

    插件名称

    设置插件的中文名称。

    插件描述

    填写用途说明,会显示在创建完成后的插件卡片中。

    版本描述

    填写插件的版本描述信息。

    WASM文件

    上传本地编译构建生成的插件二进制文件。文件名需要包含 ".wasm" 后缀。

    执行阶段

    阶段处理顺序:认证阶段 > 鉴权阶段 > 统计阶段 > 默认阶段。若不依赖其他插件执行顺序,填写默认阶段即可。

    执行优先级

    控制执行阶段内的优先级,数字越大优先级越高。若需定制,建议填写10的整数倍,预留好空间。

    适配网关版本

    选择任意版本指定版本

    任意版本:可以安装到任意版本的网关。

    指定版本:仅可以安装到指定版本(含)之后的网关版本。

插件执行顺序说明

说明

按照执行阶段和执行优先级,可以确定多个插件在处理请求和应答时的相对顺序。需要注意的是,处理客户端请求的顺序和处理后端应答的顺序是相反的,即越早处理请求的插件,越晚处理应答。

插件执行顺序由插件执行阶段和插件执行优先级两个参数共同决定,对请求和应答的处理顺序如下图所示:插件执行顺序

在平台提供插件的详情中,可以看到执行阶段和执行优先级的信息,如果希望在特定平台插件执行前后插入自定义插件,可以配置自定义插件的插件执行阶段和插件执行优先级。

常见问题

导致插件发布失败的原因可能是什么?

一般可能是生成的Wasm文件二进制格式不合法。关于在本地环境成功加载该Wasm文件的Demo示例,请参见使用Go语言开发网关插件