插件设计 - 简道云

插件设计

注：本功能需要有代码能力，若不会代码建议使用 0 代码方案解决(使用市场插件或提交需求)

1. 简介

简道云开放平台以插件为载体，允许用户在多个功能场景中，通过可插拔的自定义代码逻辑，实现一些定制需求。插件可以被分发，插件的用户无需关注代码等技术细节。

创建插件后，系统会自动为您在插件内创建一个函数。一个插件可以包含一个或多个函数。每个函数主要包含3个属性: 代码、请求参数声明（以下简称入参声明)和返回参数声明（以下简称出参声明）。

通过请求参数声明定义插件使用者需要向您的函数传递哪些参数，通过返回参数声明定义您将为用户输出哪些结果，并最终编写代码来实现从参数到结果的转换或其他自定义逻辑。

以一个翻译插件为例，您可以定义用户输入一个文本，您通过编写代码，以调用第三方 API 的方式将用户的文本翻译为日语并将结果返回给用户。用户可以将该结果回填到表单的其他字段。

插件设计流程如下所示：

1）插件设计页面及各部分功能见下表：

序号	对应功能	功能说明
❶	插件名称	——
❷	通用参数	在这里添加每个函数都需要依赖的参数，如指定平台的秘钥
❸	后端函数/前端扩展	由入参声明、出参声明和代码组成。后端函数：后端完成插件执行过程。前端扩展：在前端执行插件，可调用一些前端行为，比如：弹出iframe弹窗。
❹	可选字段	您通过拖拽字段设计参数，不同类型的字段将在用户配置/使用时产生不同的效果。
❺	请求参数/返回参数声明	您设计的请求参数，用户在使用插件时，需要为这里的每个参数指定值，这些值可以由用户直接填写，也可以配置为引用其他功能中的数据，简道云将为您完成数据绑定，您无需关注参数的来源。您设计的返回参数，用户在使用插件时，可以配置是否使用、存储至指定字段。
❻	单个参数的详细配置	定义ID 便于在代码中对变量进行引用。使用相关提示和默认值便于您的用户理解该配置的含义。

2）设计页面中的相关配置项，在前台使用插件时对应如下：

了解插件设计页面的相关内容后，即可开始设计插件。您可通过阅读以下文档，来完成插件的设计及调试：