5.2. OpenAPI 操作与 API 供应商集成流程相关


API 供应商集成的 OpenAPI 文档定义了 REST API 客户端可以调用的操作。每个 OpenAPI 操作都有自己的 API 供应商集成流。因此,每个操作也可以有自己的 REST API 服务 URL。每个 URL 由 API 服务的基本 URL 以及子路径(可选)定义。REST API 调用指定一个操作的 URL,用于触发对该操作的流执行。

您的 OpenAPI 文档决定了哪些 HTTP 动词(如 GETPOST、POST 和DELETE 等)可以在 REST API 服务 URL 中指定。对 API 供应商 URL 的调用示例位于 尝试 API 供应商快速启动示例 的说明

您的 OpenAPI 文档还决定了操作可以返回的可能 HTTP 状态代码。操作的返回路径只能处理 OpenAPI 文档定义的响应。例如,基于其 ID 删除对象的操作可能会定义这些可能的响应:

"responses": {
  "204": {
           "description": "Task deleted"
         },
  "404": {
           "description": "No Record found with this ID"
         },
  "500": {
            "description": "Server Error"
        }
}

API 供应商集成示例

下图显示了处理相关人员数据的 API 供应商集成。外部 REST API 客户端调用由 API 供应商集成部署的 REST API URL。调用 URL 会触发对一个 REST 操作的流执行。此 API 供应商集成有 3 个流程。每个流程都可以使用 Fuse Online 中的任何连接或步骤。REST API 及其流程是一台 Fuse 在线 API 供应商集成,部署在一个 OpenShift Pod 中。

API provider integration with 3 flows

在创建 API 供应商集成时编辑 OpenAPI 文档

在为 API 供应商集成指定 OpenAPI 文档后,您可以根据需要更新文档,同时为 API 操作定义执行流。为此,请点击您要编辑 API 供应商集成的页面右上角的 View/Edit API Definition。这会在 API Designer 编辑器中显示您的 OpenAPI 文档。编辑 并保存文档,以更改已反映在 Fuse Online 中。

编辑 OpenAPI 文档时的注意事项:

  • 用于同步的 operationId 属性

    API Designer 编辑器和 Fuse Online 集成编辑器中的 OpenAPI 文档之间的同步依赖于分配给文档中各个操作的唯一 operationId 属性。您可以为每个操作分配特定的 operationId 属性值,或使用 Fuse Online 生成的值。

  • 请求和响应定义

    在每个操作的定义中,您可以提供一个 JSON 模式来定义操作的请求和响应。Fuse Online 使用 JSON 模式:

    • 作为操作输入和输出数据创建的基础
    • 要显示 data mapper 中的操作字段
  • 没有 cyclic 模式引用

    API 供应商集成操作的 JSON 模式不能有cyclic 模式引用。例如,指定请求或响应正文的 JSON 模式无法整体引用,也无法通过中间 JSON 模式引用其中的任何部分。

Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat
返回顶部