自定义接口是为用户预留的编写复杂业务逻辑的地方,目前支持js语言,语法为es6,同时,在自定义接口模块,预置了SDK,扩展了文件、缓存、数据模型、sql能力。
自定义接口提供了三种模板:
- 通用:通用js模板;
- 数据模型:可以在创建自定义接口的时候,选择数据模型,以及操作类型(提交数据,更行数据,单个查询,表格/列表查询)生成对应的代码模板;
- 远程调用:提供http或者缓存的调用能力
主界面
创建自定义接口
开发自定义接口可遵循参数配置 > 业务代码开发 > 在线调试的步骤进行。
参数配置
根据实际接口需要,可在接口设计器中添加对应的入参和出参。
业务代码开发
在代码编辑器中可开发业务代码。代码编辑器为开发者提供了语法高亮、智能提醒等辅助开发能力,提示开发者的开发效率;代码编辑器右上角是工具栏,提供了快速插入引用代码、全屏、运行测试、高级配置等功能。
快速插入代码
- 自定义接口:获取自定义接口的SDK调用,您只需要在入参处填写实际入参即可。
- 连接器:获取链接器的SDK调用,可调用自定义链接器,和内置连机器,您只需要在入参处填写实际入参即可。
- 变量:获取环境变量的SDK调用,插入即可用,您不需要再做额外的操作。
高级设置
- 是否开启数据库事务:开启之后,整个js代码会包裹上事务,如果发生错误,会回滚与数据库相关的操作
- 异步执行:js异步执行
- 导入其他方法:js在引用其他自定义接口时,需要在此关联对应的自定义接口,否则,在执行时,会报错,如果是通过快速插入代码引用的自定义接口,这里会自定添加。您可以不用关注这里,如果是手动调用,需要在此关联上。
- 导入其他连接器:模板导出时会将关联的连接器导出。通过快速插入代码引用连接器时,会自动在这里添加相关连接器,您可以不用关注这里。
在线调试
代码开发完成后,点击方法测试,在抽屉中输入提交参数,点击运行测试,即可查看运行结果、运行日志等信息。
注意:在线调试的自定义接口是运行在预览环境,不会影响其他环境的数据。
接口调试通过后,点击出参映射可以快速将接口响应体接口快速设置到出参中,减轻开发者手动设置出参的难度。