API开发文档
Roy
• 发表于:2021年01月11日 15:07 • 更新于:2021年11月09日 11:12
1064

云函数

编程方法体

async function run($input,$output,$modules = modules){

//$input:输入模块,云函数的输入参数json

//$output:输出模块,云函数的输出参数json

//$modules:功能模块,可通过此模块调用功能,包含功能流程的编程的$plugin模块所有功能

}

 

$input

可通过输入模块获取输入参数值

示例:

async function run($input,$output,$modules = modules){

//获取输入参数name的值

let name = $input.name;

}

 

$output

可通过输出模块输出需要的参数

示例:

async function run($input,$output,$modules = modules){

//输出参数name的值为”bnocode”

$output.name = “bnocode”;

}

此时$output ={name:”bnocode”}

 

$modules

$modules.helper.getConfig(key)

获取API配置的参数值

输入参数

获取API配置的参数值

返回值

返回对应的value

$modules.curl(url,RequestOption)

发起网络请求,更多请参考:https://eggjs.org/api/Context.html#curl

输入参数

返回对应的value


返回值:

对应请求链接返回的数据

示例:

async function run($input,$output,$modules = modules){

let resp = await $module.curl(url,{

method:”post”,

dataType:”json”,

data:{

a:”1”,

b:”2”

}

});

}

 

$modules.data.getData(entity,id)

从数据库中获取一条数据

输入参数

输入参数

示例:

async function run($input,$output,$modules = modules){

let data = await $modules.data.getData(“5fbb88e8d878e814d75fa2f2”,”5fbb3dc52a4f132330593466”);

}

返回值

返回如果输入参数正确,则会返回获取到的数据json{},否则返回空json

$modules.data.queryData(entity,query,opetion)

从数据库中获取多条数据

输入参数

返回值

示例:

async function run($input,$output,$modules = modules){

let list1 = await $modules.data.queryData(“5fbb3dc52a4f132330593465”,{

“5fbb86ad2974d814d1cff8cd”:”aa”

});

 

let list2 = await $modules.data.queryData(“5fbb3dc52a4f132330593465”,{

“5fbb86ad2974d814d1cff8cd”:”aa”

},{

page:{

index:1,

size:100

}

});

}

返回值

返回查询到的数据collection[{},{}..]

 

$modules.data.countData(entity,query)

获取符合查询条件的数据量

输入参数

符合查询条件的数据量

返回值

查询的数据量

$modules.data.saveData(entity,form)

在数据库中保存一条数据

输入参数

在数据库中保存一条数据

示例:

async function run($input,$output,$modules = modules){

let data = await $modules.data.saveData(“5fc4ba3f9071286ceb68c25e”,{

“5fc4ba3f9071286ceb68c25c”:”产品名称”

});

}

 

$modules.data.removeData(entity,id)

删除数据库中一条数据

输入参数

删除数据库中一条数据

无返回值

 

$modules.data.updateData(enitty,id,form)

修改一条数据的内容

输入参数

修改一条数据的内容

示例:

async function run($input,$output,$modules = modules){

await $modules.data.updateData(“5fc4a58dc1a5303b948e75ef”,”5fc4a58ec1a5303b948e75f0”,{

“5fc4a58dc1a5303b948e75ee”:”111”

});

}

无返回值

 

$modules.data.bulk(entity,bulk)

针对一个数据表进行批量操作(新增、修改、删除),运行效率比前面的通过循环调用save/update/remove更高

输入参数

数据表批量操作

示例:

async function run($input,$output,$modules = modules){

await $modules.data.bulk(“5fc4ba3f9071286ceb68c25e”,{

insert:[{},{}...],

update:[{},{}...],

remove:[{},{}...]

});

}

 

 

$modules.program.exec(flow,form,version)

调用功能

输入参数

调用功能

示例:

async function run($input,$output,$modules = modules){

let res = await $modules.program.exec(“5fc4a58dc1a5303b948e75ee”,{

“5fc4a58dc1a5303b948e75ee”:{//选择数据步骤

_id:”5fc4a5adc1a5303b948e75f3”

},

“5fc4a5adc1a5303b948e75f2”:{//新增/关联获取数据步骤

“5fc072d0c1a5303b948da558”:”aa”,

“5fc4a57ac1a5303b948e75ed”:”bb”

},

“5fc4a58dc1a5303b948e75ef”:[//集合步骤

{},{}

]

});

}

 

返回值

如果调用成功,返回true,否则返回false,此外,调用成功时如果功能有设置返回值的,则返回值的data即为功能的返回值,比如:功能的返回值为”bnocode”,则res.data = “bocode”

 

webhook

编程方法体

async function hook($req = request, $resp = response, $modules = modules) {

//$req:webhook的请求对象,可获取到请求参数

//$resp:webhook的响应对象,可将webhook的处理结果返回到请求方

//$modules:功能模块,可通过此模块调用功能,包含功能流程的编程的$plugin模块所有功能

}

 

请求对象可参考:https://eggjs.org/api/Request.html#main

响应对象可参考:https://eggjs.org/api/Response.html


本文是否对您有帮助?
有帮助
没帮助
您是否遇到了以下问题?
内容过期或不准确
缺少场景、事例
链接有误
太简单,步骤待完善
其他
提交反馈
如需获取即时帮助,请联系
小助理
微信扫码添加小助理
让你的想法快速变成软件吧~
API开发文档
文章标签
API
联系我们
售前咨询电话
020-88520693
意见箱 · 建议反馈
您的宝贵建议,使白码更完美!
微信扫码添加白码小助理