文档

配置发布API

更新时间:

本文介绍如何添加触发器的发布API,如何管理触发器列表。

触发器介绍

多端低代码开发平台魔笔提供触发器功能,包含发布API定时任务

  • 发布API发布API供外部应用访问Mobi应用的数据和服务。

  • 定时任务指定时间内触发执行定时任务。

前提条件

发布API

  1. 登录魔笔

  2. 在顶部菜单栏选择应用管理,在右上角搜索框中输入目标应用,例如TEST

  3. 在指定的应用卡片中单击进入设计器,默认进入主模块的应用开发页面(Mobi Studio)。

  4. 在左侧功能区单击fig2,选择触发器页签。

  5. 在右下角单击添加触发器

  6. 在弹框的添加触发器选择发布API。

  7. 添加发布API页面中填写相关信息,单击确定image

    参数

    说明

    服务名称

    外部调用的API名称。

    版本号

    API的版本号。

    跨域设置

    设置是否使用跨域资源共享功能,勾选同意来自站点的其他服务,并单击设置,在CORS设置面板中,选择如下参数:

    允许来源全部常量

    限制时长24小时常量(秒)

    方法选择

    请根据接口的请求方式选择,支持四种方法:GET、POST、PUT和DELETE。

    • GET:请求指定的页面信息,并返回实体主体。

    • POST:向指定资源提交数据进行处理请求(例如提交表单或者上传文件)。数据被包含在请求体中,POST请求额能导致新的资源的建立和/或已有资源的修改。

    • PUT:HTTP1.1从客户端向服务器传送的数据取代指定的文档的内容。

    • DELETE:HTTP1.1请求服务器删除指定的页面。

    操作路径配置

    配置API的发布路径。

    鉴权方式

    当前仅支持mobi鉴权,需要选择对应的后端逻辑流。(选填)

    后端逻辑流

    在下拉菜单中选择已创建的后端逻辑流。

    参数管理

    您可根据需要添加要调用的API中的接口参数。

    • 参数类型:

      • PATH:指的是请求路径中${param}的param。

      • QUERY:指的是请求body中的参数。

      • HEADER:指的是请求header中的参数。

    • 数据类型仅包括:字符串、数字、布尔值。

    • 参数名称:需要调用API的参数名称。

    • 逻辑流参数名称:需要调用的逻辑流参数的名称。

    • 参数描述:简要描述参数的作用与用途。

管理触发器

  1. 登录魔笔

  2. 在顶部菜单栏选择应用管理,在右上角搜索框中输入目标应用,例如TEST

  3. 在指定的应用卡片中单击进入设计器,默认进入主模块的应用开发页面(Mobi Studio)。

  4. 在左侧功能区单击fig2,选择触发器页签。

  5. 触发器列表中,选择某条发布API记录,可对其进行编辑、删除、复制操作:

    • 编辑:单击右侧的image,可编辑发布API,完成编辑后,单击确定

    • 删除:单击右侧的fig4,二次确认后,单击确定

    • 复制模型:单击右侧的fig4图标,在下拉菜单中选择复制模型。在复制模型面板,输入复制模型名称,单击确定

  • 本页导读