新增函数

Python函数是服务编排的重要组成部分,支持将多个API的输出结果整合至一张数据表。新增Python函数的步骤如下:

第一步:进入顶部的“API管理”菜单,点击左侧的“API管理-函数”,点击“新增函数”按钮。

第二步 :基本信息配置

  • 函数名称:只支持英文、数字、下划线,且须以英文开头,同一项目内不允许重名。

  • 所属文件夹:只支持选择叶子结点中的文件夹。

第三步:函数配置

函数编辑

函数编辑工作区

函数中具有示例,用户可参考示例进行函数编辑,编辑中需要注意内容如下:

  • 主函数指定:handler

  • 支持modules:json、time、random、pickle、re、math

  • 其他填写示例:

# -*- coding: utf-8 -*-
# import module limit: json,time,random,pickle,re,math
import json

def handler(input):
    resultDict = {}
    api1 = input['input1']
    api2 = input['input2']

    totalCount = 0
    for item in api1:
        totalCount = totalCount + item['id']

    for item in api2:
        totalCount = totalCount + item['id']

    resultDict['totalCount'] = totalCount

    return resultDict

测试示例:

python入参json:{"input1":[{'id':1},{'id':2}],"input2":[{'id':1},{'id':2}]}

python返回结果:{"totalCount": 6}

输入参数

在Python代码里书写的参数名称,需要用户在输入参数中手动添加。

点击“添加参数”,在上方输入与代码中对应的参数名称input2,下方输入json格式的测试值[{'id':1},{'id':2}],如下图所示。

输入参数标识
用户必须至少配置1个“输入参数”方可运行函数,至多添加20个。

函数属性

函数属性标识
  • 历史版本:记录每一个版本的提交时间和发布时间,若一个提交版本存在多次发布,只记录第一次发布时间,无发布时间记为“-”

  • 引用信息:记录引用此函数的特定状态下的服务编排(特定状态包括已保存、已提交、已发布)

第四步:运行

运行按钮

点击“运行”按钮后,用户可在“执行结果”中查看返回结果,运行成功的函数才可以被系统允许提交,提交成功后引用此函数且状态为“已提交”的服务编排才会显示测试url,供用户使用第三方软件进行内部测试。

  • data[]:返回的数据

  • errorCode:返回状态码,对应的具体释义详见返回状态码

  • errorInfo:具体错误信息

  • Space:调用耗时(毫秒)

  • Success:调用状态(true/false)
    返回状态码对应的具体释义详见API返回状态码

Python函数一旦执行无法人为终止,建议Python代码在本地调试完毕后再于本服务中测试。