向组合件添加元素

使用 API Designer中的 组合 视图来创建 API 组合件。 您可以在 API 编辑器中点击 “网关 ”选项卡,进入“组装”视图。

关于本任务

注: 此任务与配置 OpenAPI 2.0 API 定义相关。 有关如何配置 OpenAPI 3.0 API 定义的详细信息,请参阅 编辑 OpenAPI 3.0 API 定义

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。

您可以使用 UI 中的组合件工具来创建组合件,这些组合件用于处理任何 API 操作所发出的请求或响应。

您随时可以通过点击“源代码”图标 OpenAPI 源图标,直接切换到底层的 OpenAPI YAML源代码。 要返回设计表单,请点击 “表单 ”图标 表单图标

如果要使用 " " 视图来编辑 API 定义的源,请参阅 执行 OpenAPI 扩展 ,以获取有关如何配置 OpenAPI YAML 的更多信息。

有关组装工具使用的更多信息,请阅“组装编辑器”。

过程

要使用组合件工具向组合件添加元素,请完成以下步骤:
  1. 在导航窗格中,单击 导航窗格中的 "开发" 图标 “开发 ”,然后选择 “API ”选项卡
    此时将打开 " 开发 " 页面。
  2. 单击想要使用的 API 定义的标题。
  3. 使用 " 策略 " 视图可添加元素。
    注: 必须指定策略的版本。 为避免因 API 与网关之间的策略版本不兼容而导致错误, API Connect 系统仅在 API 中的策略版本与网关上的版本完全一致时,才会将该 API 发布到网关。
    1. 选择 网关 选项卡,然后单击导航窗格中的 策略
    2. 在画布上的相应位置 圆圈内的加号 点击加号图标,即可查看列出可用元素的调色板。
    3. 点击调色板中的元素,将其添加到画布上。
      注:
      • 元素将按顺序应用,从初始未填充的圆圈变为最终已填充的圆圈。
      • 除非使用操作开关元素,否则整个组合件将适用于 API 中的所有操作。
    4. 点击该元素并使用属性表,即可添加和编辑元素属性。
      对于某些元素,您可以通过单击对象属性并从下拉列表中选择属性来添加和移除属性。 有关策略元素属性的信息,请参阅 API 策略和逻辑构造。 有关逻辑构造属性的信息,请参阅 “逻辑构造”
    5. 指定策略的版本。
      要添加一个版本,请点击 “源 ”图标 OpenAPI 源图标,并填写策略 YAML 文件中的 部分 version 。 例如:
      execute:
        - invoke:
            version: 2.2.0
            title: invoke
      ...
      必须为策略指定与您正在使用的网关兼容的版本。 发布 API 时,如果版本与网关不兼容,那么将抛出用于指定可用版本的验证错误。 有关如何配置策略 OpenAPI YAML 的更多信息,请参阅 执行 OpenAPI 扩展
  4. 可选: 对于您想要添加的任何其他元素,请重复步骤 3.b3.e
  5. 单击保存以保存更改。

结果

您已向组合件添加了一个或多个元素。