插件安装、开发

说明

Apifox 目前已支持 2 种类型插件，未来会支持更多类型插件：

• Socket 封包插件

• Socket 解包插件

开源插件

欢迎各位贡献代码。

github 地址：https://github.com/apifox/apifox-extensions

gitee 地址：https://gitee.com/apifox/apifox-extensions

开发自定义插件

插件目录

每个插件都一个文件夹，至少包含一个 JavaScript 文件。所有插件都需要放在 Extensions目录下。点击软件右上角设置形状的 icon ，选择插件管理，即可查看插件安装目录。

每一个插件都需要一个唯一的插件 ID，该 ID 需要使用倒置的域名作为前缀，如cn.apifox.ApifoxExtensions.SocketRedisUnpacker。

插件目录名必须和插件 ID相同。

插件脚本

插件目录下，需要包含一个 JavaScript 文件（支持 ES6 语法，CommonJS 模块化），该文件名必须为插件ID最后一个.后面部分，如SocketRedisUnpacker.js。

该 JavaScript 内容为一个 JavaScript 类，该类必须包含如下静态属性：

• id：即插件ID，必须和插件目录名完全一致。
• title：插件名
• type：即插件类型，取值为如下
  • socketPacker：Socket 封包插件
  • socketUnpacker：Socket 解包插件

插件脚本可以使用npm包，参考：插件中使用 npm 包

Socket 封包插件

Socket 封包插件类必须包含一个名为evaluate的方法，用来处理封包逻辑。

查看 创建 Socket 封包插件

Socket 解包插件

Socket 解包插件类必须包含一个名为onData的方法，用来处理解包逻辑。

查看 创建 Socket 解包插件