文档中心

API 编排开发

最近更新时间：2024.01.22 10:39:41

首次发布时间：2024.01.22 10:39:41

1 概述

API 编排支持构建串行、并行的工作流，通过默认创建的开始节点、结束节点，并根据实际场景，添加 API 节点、条件节点、合并节点、函数节点等节点类型，来满足更加复杂的加工逻辑处理场景。您可以把一个 API 编排看成一种特殊的 API。
本文将为您介绍在进行 API 编排时的基本步骤和注意事项。

2 使用前提

在进行 API 编排开发前，需进行以下操作，满足 API 编排的使用前提：

已加入数据服务项目，且需要是该项目的数据开发或项目管理员角色。
已在数据源模块创建了物理表和逻辑表，并拥有表的读权限。详见数据源。
已完成单个 API 开发，详见 API 开发。

3 操作流程

3.1 进入 API 编排

登录 DataLeap租户控制台。
在概览界面顶部服务窗口，单击数据服务按钮，可快速进入到数据服务 > API 界面。
在左侧目录树中，单击 API 编排按钮，进入编排配置界面。

首次进入时，单击目录树中的新建文件夹按钮，进行存放路径文件夹的创建。
输入文件夹名称信息，单击确定按钮，完成文件夹创建。

3.2 新建 API 编排

目录文件夹创建完成后，您便可开始新建 API 编排操作。

单击目录树上方新建 API 编排按钮，完成以下基本信息配置：
其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数。

参数	说明
*API 编排名称	输入 API 编排的名称信息，限100个字符以内。
*存储目录	下拉选择已创建成功的存储目录文件夹，若您还未创建存放文件夹，您可单击新建根文件夹按钮，在弹窗中完成根文件夹目录的创建。
*负责人	下拉选择该 API 编排的负责人信息，支持选择多个负责人。
安全等级	为当前 API 编排的工作流选择安全等级信息。支持选择 L1-公开、L2-内部、L3-秘密、L4-机密。
描述	为当前 API 编排添加描述信息，方便后续进行维护与管理。

编排信息填写完成后，单击保存按钮，完成 API 编排创建。

3.3 API 编排开发

创建成功 API 编排后，进入 API 编排配置界面，API 编排画板中会自动创建开始节点和结束节点。

3.3.1 界面操作说明

添加节点类型：
您可根据实际需求，在 API 编排画板中，从左侧节点类型目录中，通过拖拉拽的方式，添加相应节点类型进入画板中。

在画板中，您可进行以下操作：

序号	说明
1	双击此处，可进入编辑 API 编排节点的名称信息。编辑完成后，单击右侧保存按钮，完成节点命名。
2	单击编辑按钮，修改节点的描述信息，方便后续维护与管理。描述信息编辑完成后，单击右侧保存按钮，完成节点描述添加。
3	单击“-”或“+”按钮，调整画板的展现大小。
4	单击“定位”按钮，将编排的节点定位到画板的中心位置，方便整体查看 API 编排的工作流。
5	单击“格式化”按钮，可将混乱排布的 API 编排节点，格式化成按顺序依赖排布的工作流关系图。

在画板中的节点，您可进行以下操作，相应的示意操作图如下显示：

操作	说明
添加依赖	您可通过拉线的方式，来编排工作流节点之间的依赖走向。
添加节点	在上下游节点的依赖线中间处，单击“+”按钮，可在两个节点间，再次进行编排节点的添加操作。
删除节点	您也可以单击节点，单击在节点上方展现的删除按钮，将多余的节点进行删除，若存在上下游依赖关系，则节点删除后，相应的依赖关系会一并会被删除。说明默认添加的开始节点、结束节点，不支持进行删除节点操作。
删除依赖	鼠标点击上下游节点间的依赖连线，单击展现的删除按钮，可将当前的依赖进行删除。

3.3.2 节点说明

目前 API 编排支持 6 个节点，您可根据您的业务场景逻辑来编辑不同的节点，从而实现您的功能需求。

节点类型	说明
开始节点	开始节点即为整个 API 编排的开始节点，类似 API 的请求参数，您可以在开始节点中单击“添加”按钮，并填入请求参数作为整个 API 编排的入口。
结束节点	结束节点即为整个编排的输出，类似 API 的返回参数，您可在结束节点中添加 API 编排整体的返回参数。您可在编排开发完成后，进行 API 编排测试，测试完成并且成功返回结果后，可以单击解析参数按钮，把测试返回的参数同步到结束节点中。
函数节点	函数节点目前只支持火山引擎 Faas 函数，您可以单击“前往 Faas 函数”按钮，前往函数服务，开发自己的函数，将创建后的函数名称、调用链接 Url 信息，填入函数节点中。说明目前函数节点引用的 Faas 函数仅支持 POST 的 HTTP 调用。您可根据场景需求，创建相应的函数，但函数最终返回的数据格式是固定的。示意如下格式： `{ "fields": [ { "Name": "limit", "Type": "int" } ], "data": [ [ 10 ] ] }` 函数更多操作详见创建函数。函数创建完成之后，您可在函数详情界面，单击触发器页签，创建相应的 API 网关触发器。创建操作详见创建 API 网关触发器。创建好触发器后，您可以用相应的访问地址，进行调用。例如，您可以将触发器中的公网地址，复制到 API 编排的函数节点中即可调用相应的函数。函数节点配置完后，您可单击上方“节点测试”按钮，进行函数节点的测试。
分支节点	分支节点即为条件节点，可以针对上游节点的输入来决定调用不同的下游节点。如下图所示，输入参数即为上游节点【函数节点】的输出，您可单击“解析”按钮，快速添加输入参数。输入参数配置完成后，单击分支配置页签，进行分支走向的配置。分支配置即为根据输入参数的实际值，通过设置的判断来调用不同的下游节点。如下图所示，如果上游【函数节点】的输出值大于10，则会接着调用【API节点1】；如果上游【函数节点】的输出值小于等于10，则会调用【API节点2】
API 节点	API 节点可以下拉选择当前目录下已成功上线的脚本式或向导式 API，请求参数和返回参数会自动沿用您选择 API 的请求和返回参数。 API 节点选择完成后，您可单击节点测试页签，进行 API 测试，与单个 API 测试一致，输入请求参数，单击测试按钮，即可看到返回结果。
合并节点	合并节点可以把上游多个节点的返回参数进行合并操作，目前有两种合并方式。 append：需保证上游节点返回值字段和类型一致，取相同字段作为返回参数； merge：将上游节点所有返回字段合并。说明合并节点返回参数字段说明如下：来源节点参数名称：标注当前返回字段来源于上游的哪个节点；参数别名：如果返回字段存在多个重复名，需要变更别名。