保存与调试
1. 功能简介
当所有参数及代码都编辑完成后,需要保存插件。
- 保存并调试:当插件开发完毕后,可以保存插件当前配置,并进行调试以此来检查开发的插件的代码及配置问题。
- 保存:指的是将当前配置内容保存下来,以便后续继续编写或直接使用。
2. 保存规则
2.1 保存机制
在设计插件时,切换插件设计或插件属性的任意一个页面将会触发插件设计的自动保存机制,无需手动保存。
若修改了插件设计,且从当前设计页面直接点击返回按钮,系统会给出未保存的提示,可以点击保存再返回插件管理页面。
2.2 执行规则
不同的选择对应的执行规则如下:
- 保存并继续:保存插件的编辑操作,回到插件管理页面;
- 不保存:保留上一次保存的设置内容,不保存本次改动,回到插件管理页面;
- 返回插件设计:回到当前设计页面,不执行任何操作。
3. 插件调试
3.1 调试入口
当插件开发完毕后,可以对插件进行调试,以此来检查开发的插件的代码及配置问题。点击「保存并调试」按钮,进入「插件调试」页面进行调试。
3.2 触发动作及执行代码
1)进入「插件调试」页面后,可以选择对应的「模拟触发动作」,选择完成后,点击「执行代码」进行调试。
2)左侧为模拟插件执行时会传递给插件的数据。其中:
- anentConf:代码部分模拟通用参数;
- triggerConf:代码部分模拟请求参数;
在左侧请求内容中按照格式填好测试的值后,点击「执行代码」后,这些值将会同步传递给插件。传递完成后,插件执行结果会显示在返回内容处,您可以查看代码返回内容是否符合预期。
3.3 查看标准示例
1)在「查看标准示例」中,能够获取到最新的参数设计的对应结构。在编写请求内容时,您可从标准示例中复制代码到左侧,再根据自己的需求修改具体的参数值。
2)如在「查询简道云部门下的成员」插件当中,进行「查询成员」函数调试时,可将标准示例代码复制到左侧请求内容中,再对 agentConf 和 triggerConf 进行如下所示的修改:
- agentConf:修改 apiKey 为简道云中的 apiKey;
- triggerConf:可根据企业信息,修改内容为需要查询的部门编号;
根据企业信息修改完成后,点击「执行代码」,即可在「返回内容」中,查看成员查询结果,如下所示:
3.4 返回内容
点击「执行代码」后,能够在插件调试页面右侧,查看到对应的返回内容。如下所示: