6.4. 为 API 供应商集成定义操作流
定义 REST API 服务的 OpenAPI 文档定义服务可以执行的操作。创建 API 供应商集成后,您可以编辑每个操作的流。
每个操作都只有一个流。在操作流中,您可以添加到其他应用程序和服务的连接,以及在连接间操作数据的步骤。
当您添加到操作流时,您可能会发现需要更新 API 供应商集成的 OpenAPI 文档。要做到这一点,请点击您要编辑 API 供应商集成的页面右上角的 View/Edit API Definition。这会在 API Designer 编辑器中显示您的文档。在 OpenAPI 定义中,只要每个操作都有唯一的 operationId 属性,您可以在 API Designer 中保存更新,Fuse Online 可以同步 API 供应商集成的流定义来具有您的更新。
先决条件
- 您创建了 API 供应商集成,为它提供一个名称并保存。
- 您创建了与希望操作流连接的每个应用程序或服务的连接。详情请查看 创建连接的信息。
- Fuse Online 显示 API 定义的操作列表。
流程
- 在 Operations 列表页面中,针对您要编辑的操作,点 Create flow。
对于您要添加到此流的每个连接:
- 在流视觉化中,点加号在该位置添加连接。
- 点击要添加的连接。
- 选择您希望此连接执行的操作。
- 通过在标记的字段中输入数据来配置操作。
- 点击 Next。
在继续操作前,将所有所需的连接添加到流。
在这个操作流中,要处理连接间的数据:
- 在流视觉化中,点您要添加步骤的加号。
- 点您要添加的步骤。
- 通过在标记的字段中输入数据来配置步骤。
点击 Next。
有关帮助,请参阅 在连接之间添加步骤。
如果要添加另一个在连接间处理数据的步骤,请重复这个指令子集。
将数据映射到下一个连接中的字段:
-
在流视觉化中,检查数据类型不匹配
图标,这表示连接无法处理传入的数据。您需要在此处添加数据映射程序步骤。
对于流视觉化中的每个数据不匹配图标:
- 单击该步骤前的加号。
- 单击 Data Mapper。
- 定义所需的映射。有关帮助,请参阅 下一个连接中的将集成数据映射到字段。
- 点 Done 将数据映射程序步骤添加到流中。
-
在流视觉化中,检查数据类型不匹配
在流视觉化中,在 Provided API return Path 步骤中,点 Configure。
每个 API 提供程序集成通过向触发操作流执行的 REST API 调用者发送响应来完成每个操作流。响应包含您为用来完成操作流的 Provided API 返回路径 步骤配置的返回代码之一。配置返回路径步骤,如下所示:
- 在 Default Response 下,在 return Code 字段中,接受 Fuse Online 显示的默认响应,或者点击 down caret,并滚动来选择您需要的默认响应。当执行操作流时,流不会返回任何配置的错误响应,流会发送此响应。通常,默认响应返回代码表示操作成功。
在 Error Handling 下,指示您是否要在返回消息的正文中包含错误消息。
在开发过程中,您通常想返回错误消息。但是,在生产环境中,如果包含敏感或专有信息,您可能希望隐藏错误消息。错误消息是一个 JSON 格式的字符串,其中包含
responseCode、类别和message元素,例如:{ responseCode: 404, category: "SQL_ENTITY_NOT_FOUND_ERROR", message: "SQL SELECT did not SELECT any records" }{ responseCode: 404, category: "SQL_ENTITY_NOT_FOUND_ERROR", message: "SQL SELECT did not SELECT any records" }Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在 Error Response Codes 下,Fuse Online 会显示流中连接可能会返回的每个错误的条目。对于每个错误,接受 200 All is good 默认返回代码,或者点击以选择另一个 HTTP 状态返回代码。
您可以从中选择的返回代码是 OpenAPI 文档为此流执行的操作定义的返回代码。如果 Fuse Online 没有显示您需要的返回代码,您可以编辑 OpenAPI 文档来添加它。
为此,请在右上角点 View/Edit API Definition。根据需要编辑 OpenAPI 文档。完成后,保存 OpenAPI 文档。Fuse Online 返回编辑 Provided API 返回路径,并反映您保存的任何更改。
- 点 Next 完成返回路径的配置。
当此流具有所有必需的连接和步骤,且没有数据不匹配图标时,或者您现在不再需要编辑流,请执行以下操作之一:
- 发布 criu-wagonTo 开始运行集成,在右上角点 Publish。这会构建集成,将 REST API 服务部署到 OpenShift,并使集成可用。每次完成操作流创建或每次编辑操作流时,您可以发布集成。
- 保存 mvapich-wagonTo 显示右上角的操作列表,点 Save。
重复此步骤以编辑另一个操作流。
测试 API 供应商集成
测试在这些平台上运行的 API 供应商集成:
- OpenShift Online
- OpenShift Dedicated
- 当 API 发现被禁用时,OpenShift Container Platform
您可以使用
curl工具确认集成是否按预期工作。在curl命令中,指定 Fuse Online 发布 API 提供程序集成后显示的外部 URL。有关执行此操作的示例,请参阅 测试示例 API 提供程序快速启动集成。在启用 API 发现时测试在 OpenShift Container Platform 上运行的 API供应商集成
OCP 管理员可能已设置
OPENSHIFT_MANAGEMENT_URL_FOR3SCALE环境变量。当设置此环境变量时,Red Hat 3scale 会发布您的 API 供应商集成,这意味着 3scale 控制对集成 API 的访问。要测试集成,请打开 3scale 仪表板来获取集成的 URL。如果您不希望 Red Hat 3scale 控制对集成 API 的访问,您可以禁用发现。通过查看集成摘要页面,在 Fuse Online 中执行此操作。在此页面上,单击 Disable discovery。Fuse 在线重新发布集成并提供外部 URL 来调用集成执行。
您可以为每个 API 供应商集成启用或禁用发现。