API 输入节点

更新时间:2018-09-28 20:18:17

API输入节点是一个api流的起始节点,每个API有且仅有一个请求节点。api输入节点主要用于api入参定义和api的调试。

image.png | left | 747x412

入参定义

在API输入节点的配置面板中,可通过 新增入参 按钮进行 API接口参数配置,界面如下:

image.png | left | 747x428

  • 参数名称:api请求的参数名称

  • 类型:字段的类型,支持:String、Int、Long、Float、Double、Boolean

  • 是否必填:指此参数是否为必填指,当选择为是时,平台会校验用户的请求中是否包含了此参数,若不存在则拒绝用户请求

  • 默认值:当“是否必填”为否时生效,在用户请求中不包含此参数时,平台自动添加默认值给后端服务。若用户传递,则按用户请求传递给后端服务

  • 示例:指参数的填写示例,生成 API 文档时的参数示例

  • 描述:参数的用途描述及使用的注意事项

API调试

对api进行调试前需要完成以下操作:完成api的编排;完成api入参的定义;点击部署按钮将api部署至云端。然后,在api输入节点的配置面板中入参名称后的输入框中填入调试的参数值,点击运行按钮,即可模拟api的调用。运行完成后,可在工作台底部的api调用结果和调试日志中查看调试结果。如果实际运行结果与期望不一致,可修改编排,重新部署->运行,反复上述过程直至期望值与实际运行结果一致。

results matching ""

    No results matching ""