有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
本文将介绍如何使用和管理自定义 API。

使用自定义 API

目前在应用编辑器和自定义代码中,都可以使用自定义 API,支持可视化和自定义代码两种方式。

通过组件行为调用

进入应用编辑器,在组件行为事件中可以调用 API 方法,详情可参见 行为事件-执行动作

通过低代码编辑器调用

进入应用编辑器,可以在应用的低代码编辑器及微搭组件的组件代码中使用,详情可参见 代码编辑器。 示例代码:
export default async function({event, data}) {
const result = await $w.cloud.callDataSource({
dataSourceName: '自定义 API 标识',
methodName: '方法标识',
params: {}, // 方法入参
});
}


在自定义代码中调用

在自定义 APIs 中通过自定义代码方式,可以调用其他自定义 API。详情请参见 自定义代码。 示例代码:
module.exports = async function (params, context) {
const result = await context.callConnector({
name: '自定义 API 标识',
methodName: '方法标识',
params: {}, // 方法入参
});

return {
_id: '123456',
};
};


编辑 API

有两种方式可以对 API 进行编辑:
控制台 APIs 列表 页面,找到编辑的 API,在操作列单击编辑
控制台 APIs 详情页面,单击右上角编辑

发布数据模型

数据模型需要发布才会在正式环境生效,有两种方式可以发布数据模型:
数据模型列表页面,找到编辑的数据模型,在操作列单击更多 > 发布
自定义 API 详情页面,在基础信息卡片中状态 > 立即发布

删除 API

自定义 API 列表页面,找到编辑的自定义 API,在操作列单击更多 > 删除
注意
自定义 API 删除前,必须解绑在所有应用的关联使用。