从头开始为 API 创建流

您可以在 App Connect为 API 创建流 (也称为 API 流 )。 定义的配置提供了用于公开一个或多个操作的 API。 您可以使用这些操作来调用端点,并在该端点与流中的应用程序之间传递数据。

准备工作

  • 如果知道需要哪些应用程序或导入的 API,可在 App Connect 应用程序和 API 页面上为针对目标应用程序或 API 运行 API 操作的连接器创建账户。 您还可以在创建流时创建帐户。 有关更多信息,请参阅 连接到帐户
  • 要使用 统一编写 来创建可在 IBM® API Connect中管理的 API 流,请确保满足以下需求。
    • 您必须在同一区域拥有一个 IBM API Connect Enterprise as a Service 在同一区域中,与您的 IBM App Connect Enterprise as a Service 实例在同一区域。 如果您已经拥有 App Connect ,您可以在同一区域配置一个 API Connect 在同一地区创建试用实例。 提供一个 API Connect Enterprise as a Service 的试用实例。 App Connect 主页 ,单击管理 API 流量,使用 IBM API Connect。
    • 必须使用至少一个已注册的 DataPower API Gateway 服务来配置 API Connect 实例。
    • API Connect 实例必须至少包含一个您有权访问的提供者组织。 提供者组织必须包含包含具有所属使用者组织和客户机标识的应用程序的目录。
    • 您必须为您的实例启用统一创作。 在 API 流程编辑器的设计器选项卡上,单击更改 API 网关设置图标 "更改 API 网关设置图标,启用统一创作,然后单击保存。 (如果您的 API Connect 功能,或者在与您的 webMethods 混合集成环境相同的区域内没有 API Connect Enterprise as a ServicewebMethods 的实例,则更改 API 网关设置图标将被禁用)
      集成创作功能在 API 网关设置中已启用。

关于本任务

为 API 创建流时,每个单独的流都是通常从移动和 Web 应用程序调用的 API 操作的实现。 (操作示例为 "GET order" 和 "POST order"。) 每个操作的流包含一个请求,一个或多个应用程序或导入的 API 的操作以及 API 操作的响应。 该流还可能包含用于专门数据处理的工具箱节点。 该请求使用您定义的模型来请求在应用程序中创建,检索或替换数据对象。 提交请求时,每个目标应用程序或 API 都会完成其操作。 然后流会返回响应,响应确认操作成功或返回请求的数据。

定义 API 涉及以下高级步骤。
  1. 您可以创建一个或多个模型,用于定义要创建或检索的对象的结构。 最多可以创建 10 个模型。
  2. 选择要针对每个模型完成的内置创建,检索或替换或更新操作,或者定义您自己的定制操作。
  3. 您可以配置流以实现每个操作,并为一个或多个目标应用程序或 API 添加操作。 您还可以向流添加工具箱实用程序,以处理来自这些应用程序的输入或输出数据。
统一编写:

如果您的 API Connect 的实例与您的 App Connect 实例在同一环境或区域,您就可以在 App ConnectAPI Connect. 此功能称为 统一编写。 默认情况下,统一编写功能被禁用。

有了统一创作,当您在 App Connect 中创建并启动 API 流程时,API 会自动添加到产品中。 然后,该产品将在目录中发布,该目录将在以下网站中提供给提供方组织 API Connect. 如果启用了 API Connect 开发人员门户网站上可见。 发布首选项基于登录的用户。 App Connect 自动发现提供商组织 API Connect 的提供商组织。 App Connect 实例。 您可以指定将 API 发布到首选 API Connect 实例和提供商组织的设置。 您还可以选择目录和网关目标,已发布 API 的包含产品和计划以及消费应用程序。

中的应用程序接口。 API Connect 中的应用程序接口 App Connect. 您还可以在 Developer Portal 中浏览产品 (和 API)。 当您在 App Connect 中停止 API 时,API 管理器用户界面和开发人员门户网站中的产品(和 API)将自动删除。 (无权访问 API Connect 的用户可以在 App Connect中停止流。 但是,该 API 仍发布在 API Connect中。)

如果您有权访问 webMethods Hybrid Integration 中的 API Connect 功能,或者有权访问与 IBM API Connect Enterprise as a Service 实例位于同一区域的 IBM App Connect Enterprise as a Service 实例,那么您可以启用统一创作。 启用统一创作后,创建并启动 API 流程时,流程会自动发布到 API Connect. 如果启动 API 流而未指定发布首选项,API 将发布到您发现的任何实例中的沙盒目录中自动生成的产品中的默认计划。 API Connect 实例的沙盒目录中自动生成的产品中发布。

您可以使用 App Connect 中的 API 编辑器来创建 API 流程,并为您的 API 定义模型和执行操作。 您还可以配置策略,网关和门户网站设置,以控制在启动流后将 API 发布到 API Connect 时的行为。 以下任务描述如何在 API Connect中创建 API 流,配置发布首选项以及访问已发布的 API。

App Connect 中创建 API 流

过程

要创建 API 流,请完成以下步骤。

  1. App Connect 主页上,单击为 API 创建流程
    或者,转到 App Connect Designer 仪表板 代表 App Connect Designer 仪表板的图标 然后单击创建 > API 的流
    这将打开 API 编辑器,其中包含三个选项卡。
    设计师
    使用 Designer 选项卡为 API 创建模型和操作。
    OpenAPI
    使用 OpenAPI 选项卡以符合 OpenAPI 3.0 规范的格式查看 API 的表示。
    网关
    如果启用了统一编写,请使用 网关 选项卡来查看网关可用于在 API Connect中调用已发布 API 的缺省设置。 您还可以强制实施额外的 API 策略,或者为此 API 配置网关和门户网站设置。

    如果禁用了统一编写,那么 网关 选项卡会提供指示信息以将其启用。

  2. 可选: 要启用统一创作,请转到设计器选项卡,单击更改 API 网关设置 更改 API 网关设置图标 ,启用统一创作,然后单击保存
    启用统一创作后,您可以查看和编辑发布 API 文档的首选项。 这些首选项将在步骤 15 中说明。
  3. 输入用于标识流用途的名称。
    显示 API 编辑器的三个选项卡的截屏,其中流的名称设置为 Customer API。
    提示:如果使用 "flow runs计划,流量名称最多可包含 32 个字符。 在 "flow runs计划上部署流程时,部署会使用流程的名称,部署名称最多可包含 32 个字符。
    当您使用流程时, App Connect 会自动保存更改。 如果您离开该流,那么该流将保存为您可以在其他时间完成的草稿流。
  4. 要创建用于定义要使用的对象结构的模型,请在 模型名称中输入名称,然后单击 创建模型
    例如,您可能需要可以为其创建,检索或更新记录的客户对象。
    模型面板有两个选项卡。
    属性
    使用 属性 选项卡来定义模型的结构。
    操作
    使用 操作 选项卡来定义 API 如何与模型交互。
    具有 "属性" 和 "操作" 选项卡的模型面板
  5. 属性 选项卡上,通过配置属性来定义模型的结构。
    注: 属性具有以下需求和限制。
    • 每个属性名称必须唯一。
    • 名称必须仅包含字母,数字或下划线字符。
    • 名称中不允许使用空格,但可以使用下划线字符 (_) 来分隔单词。
    • 名称必须以字母或下划线开头。
    1. 要添加第一个属性,请输入名称并为该属性选择数据类型。
      缺省情况下,您添加的第一个属性已选择 标识 选项。 流必须返回在创建对象时指定为模型标识的属性。 还必须在请求中发送标识属性,以使用其标识更新或检索对象。 针对一个属性设置标识。
      提示: 要从连接到的应用程序添加属性,还可以单击 从应用程序中选择属性。 选择相应的帐户,选择一个或多个属性,然后单击 添加属性
      显示用于从应用程序中选择属性的对话框的屏幕快照。 选择已连接的 HTTP 计数,并显示请求属性列表。
    2. 要添加更多属性,请单击 添加属性
      屏幕快照显示客户 API 模型的属性。 为 CustomerID, FirstName, LastName, 和 Email 创建了字符串类型属性。
  6. 可选: 要创建更多模型,请单击 创建模型 并为每个新模型添加属性。
    要编辑模型的名称或删除模型,请使用菜单中的相应选项。
    屏幕快照显示模型的下拉菜单,其中包含选项 "编辑模型信息" 和 "删除模型"
  7. 要定义 API 如何与模型交互,请单击 操作
    • 要添加其中一个内置操作,请单击 选择要添加的操作,然后选择 创建检索替换或创建 操作以对模型运行。
      显示 "选择要添加的操作" 菜单中的选项的屏幕快照
    • 如果选择涉及过滤器的操作,请选择相应的过滤器属性。 对于 使用过滤器检索 模型名称 操作,您还可以启用和配置结果的分页设置。 分页允许您的 API 在每次运行 API 时返回数据的 "页面"。 limit 参数说明要返回的记录数。 skip 参数指定在流开始返回记录之前要跳过的记录数。 token 参数是一个字符串, API 可以使用此字符串来标识从何处开始返回记录。
      要应用过滤器,必须至少定义两个属性,包括模型的 标识 属性,因为无法选择标识属性作为过滤器。
      显示具有过滤器操作的 "检索" 模型的过滤器属性的截屏

      有关更多信息,请参阅 IBM Integration 社区中的在 IBM App Connect 中引入 API 流的过滤器参数在 API 流中使用过滤器操作配置分页

    • 要定义您自己的操作,请单击 选择要添加的操作,然后选择 添加定制操作
      限制: 查询参数不能与模型标识相同,并且定制操作的名称不能是下列任何关键字。

      create, updateOrCreate, replaceOrCreate, findOrCreate, buildNearFilter, all, destroyAll, count, save, update, destroy, delete, remove, replaceById, updateAttributes, patchAttributes, upsertWithWhere, getChangeModel, getIdName, getSourceId, handleChangeError, rectifyChange, replaceById, replaceOrCreate, replicate, updateAll, upsert, upsertWithWhere, destroy, fillCustomChangeProperties, getId, isNewRecord, reload, replaceAttributes, save, setId, updateAttribute, updateAttributes

  8. 配置用于实现操作的流:
    1. 单击 实现流
      显示 "操作" 选项卡上模型旁边的 "实现流程" 按钮的截屏
      流编辑器包含基本流结构,其中包含 请求 节点, 响应 节点以及用于添加一个或多个目标应用程序,导入的 API 或工具箱实用程序的空间。 请求主体示例的结构是根据模型中的属性构造的,其中包含一些样本数据。
      在流编辑器中显示 API 流的截屏。 流包含 "请求" 节点和 "响应" 节点,并显示请求的样本内容
    2. 要将应用程序或导入的 API 添加到流,请单击 (+),选择应用程序或 API ,然后选择相应的操作。
      确保为 App Connect 连接到目标应用程序或 API。 如果没有连接任何帐户,您可以按照连接到帐户中的说明进行连接。 如果在目录中没有看到要添加的操作的连接器,请尝试在 IBM Automation Explorer. 您还可以使用连接器开发者套件来创建连接器。 更多信息,请参阅添加或创建社区连接器
    3. 使用要传递到目标应用程序或 API 的值填写操作的字段。 您可以纯文本形式指定静态数据,也可以通过在流中添加来自先前节点的映射来指定动态数据。 您还可以应用函数 (或 JSONata 表达式) 来变换数据,或者使用其他内置机制来定义定制值。

      要手动输入文本,映射和 JSONata 表达式,或者要定义您自己的定制值,请参阅 配置操作

      要使用建议的智能映射自动填充操作的字段,请使用映射辅助 (请参阅 使用 AI 支持的建议简化数据映射和数据转换)。
      屏幕快照显示了 Salesforce中 "创建联系人" 操作的已完成映射。 Salesforce 操作中的账户 ID、姓氏和名字属性分别映射到 API 模型的 CustomerID, LastName, 和 FirstName 属性。
      提示:在添加映射时,您可以使用自动生成或自定义的示例数据来测试映射。 更多信息,请参阅使用样本数据测试映射。 完成操作字段后,还可以使用样本数据来测试操作。 要测试该操作,请确保您正在使用非生产帐户,因为该操作是在您所连接的目标应用程序上完成的。 更多信息,请参阅使用样本数据测试操作
    4. 可选: 添加更多应用程序或导入的 API。
    5. 可选: 使用一个或多个受支持的工具箱实用程序来提供专用处理。
      例如,添加 If 节点以提供条件处理,或者添加 For each 节点以处理检索到的项。 有关更多信息,请参阅 向流添加特殊处理 (工具箱实用程序)
    6. 单击流中的 响应 节点以定义在操作成功完成时返回的响应。
    7. 响应头 部分中,指定首选响应状态码。

      创建 操作会返回响应代码 201 (已创建记录)。
      检索 操作返回响应代码 200 (检索的记录)。
      替换或创建 操作返回响应代码 200 (已替换记录) 或 201 (已创建记录)。

    8. 响应主体 部分中,通过使用文本,来自流中先前节点的映射或 JSONata 表达式来定义在响应主体中返回的字段。
      显示已通过将 API 操作的 CustomerID 属性映射到 Salesforce 中的 "联系人标识" 属性来配置响应的截屏
      提示: 在创建对象时,通常只会在响应消息中返回来自目标应用程序或 API 的标识。 如果要检索对象,那么响应消息将显示您从目标应用程序或 API 请求的所有字段。

      在配置流中的所有节点之后,可以使用自动生成的或定制的样本数据来测试流,然后再将其启动。 确保在测试流时使用非生产帐户。 将在您连接到的目标应用程序上完成流中的已配置操作。 有关更多信息,请参阅使用样本数据测试流程

    9. 单击 完成 以返回到模型。
  9. 为模型定义进一步的操作,并配置用于实现每个操作的流。
    显示模型的多个操作 (包括创建,按标识检索以及使用过滤器模型进行替换或创建) 的截屏
  10. 定义任何其他模型的操作并实现其流。
  11. 可选:您可以添加错误捕捉流程,以处理 API 流程中的错误。
  12. 在测试或部署流程之前,请修复流程中的任何验证错误。
    有关更多信息,请参阅验证流程
  13. 可选: 要查看流的 API 定义,请单击 OpenAPI 选项卡。
    API 定义显示在表单视图 表单图标 中,该视图类似于在 API Connect. 此选项卡中的详细信息是只读的,但在 API 编辑器中更改流的模型和操作时会自动更新。 缺省情况下,将展开表单视图的 常规 类别。 以下类别也可用。 (此视图中的某些部分当前不适用,或者不显示 API 的任何详细信息。)
    组件 类别显示与 API 定义的各个方面相关的可复用对象。
    • 模式 显示有关每个模型及其属性的详细信息。
    • 响应 不适用。
    • 参数 不适用。
    • 示例 不适用。
    • 请求主体 不适用。
    • 不适用。
    • 安全方案 显示用于在调用 API 操作时提供凭证 (客户机标识) 的预先配置的 API 密钥安全方案的详细信息。 安全方案名称作为类型为 apiKeyclientID 提供,并且 X-IBM-Client-Id 参数用于在 API 的请求头中传递凭证。
    • 链接 不适用。
    OpenAPI 选项卡上的 "组件" 部分
    常规 类别包含以下部分。
    • Info 部分包含 API 摘要。 该部分包括作为标题的流程名称、根据流程名称生成的名称(用于标识 API)以及指定的版本(通常为 0.0.1)。 其余字段为空。
    • Servers 部分显示了用于连接目标服务器的 API 中的服务器定义。 VPC hours 计划上测试 API 时,API 会临时部署到默认集成运行时。 因此,API 端点以 https://default-integration-runtime 开头,例如
      https://default-integration-runtime-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
      VPC hours 计划上部署 API 时,API 会部署到您创建的运行时。 因此,API 端点以运行时名称开头,例如
      https://my-custom-ir-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
      如果您使用的是 flow runs 计划,服务器 URL 将以正斜线 (/) 开头,然后是流量名称,并用下划线 (_) 代替空格;例如, /Customer_API
      VPC 小时计划上 API 的服务器部分显示了默认集成运行时上 API 的服务器 URL。
      流程运行计划中 API 的服务器部分会将流程名称显示为服务器 URL。
    • 安全性 显示对 API 实施的安全性需求。 缺省情况下,将配置类型为 apiKeyclientID 安全方案。
    • 外部文档 不适用。
    • 标记 不适用。
    OpenAPI 选项卡上的常规部分
    路径 类别显示 API 流中每个已定义操作的路径。 每个路径包括一个 HTTP verb 和一个 URL (相对)路径,并定义了如何公开 API。 您可以点击展开导航窗格中的每个 URL 路径,以进一步探索。 此类别包含以下部分。
    • 服务器 不适用。
    • 参数 不适用。
    • 操作 显示基于操作类型的详细信息。 例如,您可能会看到标记 (对应于模型名称) ,路径或查询参数或响应代码和描述。
    OpenAPI 选项卡上的 "路径" 部分
    您可以在用户界面中单击 源图标 ,查看 API 定义的底层 OpenAPI YAML 源。 此视图也是只读的,并且 YAML 源符合 OpenAPI 3.0 规范。
    API 定义的源视图
  14. 可选: 如果启用了统一编写,请单击 网关 选项卡以查看和配置策略以及网关和门户网站设置。 在此配置的任何设置都会影响在 API Connect 中运行的 API 没有影响。 App Connect.

    如果已禁用统一创作,请转到步骤16启动流程。

    策略
    使用此视图来查看组合件编辑器并创建组合件以定制 API。 组合件由应用于 API 中的操作的调用和来自操作的响应的元素 (例如策略或逻辑构造) 组成。 组合件编辑器包含列出可用元素的选用板。 它还包含用于配置元素的 slide-out 属性表,以及用于排列和可视化组合件元素的画布。 有关更多信息,请参阅程序集编辑器API 策略和逻辑构造 ,以及处理程序集中的错误API Connect 文档中的程序集错误处理。
    "策略" 视图中的组合件编辑器
    首次打开 " 策略 " 视图时,画布会提供单个 Invoke 策略来运行 API。 网关可使用此策略在 App Connect. 您可以单击以打开此策略的属性表。 不过,您不需要编辑任何默认设置,其中还包括 HTTP 基本身份验证的用户名和密码。 app-connect-designer-url 变量在 URLURL 字段中的变量代表网关需要访问的当前 App Connect 实例,网关需要访问该实例。 此 URL 在 “网关” 选项卡的 “网关和门户设置” > “属性” 下定义。
    注意: 请勿删除默认的 Invoke 策略(标题为 Invoke flow ),除非您能设计出访问 App Connect 端点 URL 以调用 API。 app-connect-designer-url 定义了端点 URL。
    在属性表中调用流策略缺省设置
    您可以从选用板添加其他策略或逻辑构造以满足您的需求。 例如,要限制对 API 的调用,可以将 Rate limit 策略拖到组合件中的正确位置。 然后,可以使用属性表来定义在指定时间段内允许的最大调用数。 更多信息,请参阅 API Connect 文档中的 " 速率限制 "。
    提示: 如果在组合件中定义了速率限制,那么仅影响组合件中该点的调用。 如果计划允许调用继续,但超出了组合件上设置的硬限制,那么将在设置速率限制的过程流中的点停止调用。 在完成速率限制策略之前,组合件的过程流中出现的任何操作。 仅取消在速率限制策略之后出现在流中的操作。
    组合件编辑器画布中的速率限制策略
    网关和门户网站设置
    使用此面板来查看 API 的常规配置设置并更新其中一些设置。 更多信息,请参阅文档中的 " 指定网关和门户设置 "。 API Connect 文档中的指定网关和门户设置。
    "网关和门户网站设置" 部分
    提示: 默认 app-connect-designer-url 属性(在网关和门户设置 > 属性下)定义了当前实例的 URL。 App Connect 实例,网关使用该实例进行访问。 请勿删除或编辑此属性。
    "网关和门户网站设置" 部分
  15. 可选: 如果启用了统一编写,请为 API Connect配置发布首选项。

    如果已禁用统一创作,请转到步骤16启动流程。

    仅当流停止时,才能配置或更新发布首选项。 发布首选项仅与该流相关联。

    如果启动 API 流而不首先为该流设置发布首选项,那么将使用为流保存的最后一组用户首选项。 如果之前没有设置首选项,API 将发布到您发现的任何实例中的沙盒目录中自动生成的产品的默认计划中。 API Connect 实例。

    1. 在 API 编辑器的设计器选项卡上,单击更改 API 网关设置图标 更改 API 网关设置图标
      API 编辑器中 "首选项" 图标的位置
      此时将打开 " API 网关设置 " 面板。
      API 网关设置面板的截屏
      注: 如果您不想将 API 流自动发布到 API Connect,那么可以在此面板上禁用统一编写。 在流启动后运行时,无法禁用统一编写或更新其他首选项。 您可以只读方式查看所选首选项,但如果要更新这些首选项,那么必须停止流。 停止流时,将删除已发布的 API。 重新启动流后,将根据更新后的首选项重新发布 API。
    2. API 管理 属性是值为 API Connect的只读字段。 在 API Connect 中,每个实例都有一个提供商组织。 因此,请使用 提供者组织 属性来指定要将 API 发布到的 API Connect 实例。
    3. 登台目标和运行时设置下,使用 编辑 链接来定义可通过其发布产品 (和 API) 的登台目标以及托管已发布 API 的网关服务。
      目标目录
      指定要通过其发布包含 API 的产品的目录。 所选目录将用作其他首选项设置的作用域。
      • 使用缺省内置沙箱目录: 单击此选项以使用沙箱目录。
      • 选择现有目录: 单击此选项以选择您选择的目录。
      目标空间
      如果所选目录已分区到空间中,请指定要发布到的空间。
      注: 如果选择使用内置沙箱目录,那么不会显示 目标空间 选项,因为无法对此目录启用空间。 如果选择了未分区到空间中的现有目录,那么也不会显示 目标空间 选项。
      目标网关服务
      指定哪些网关服务提供用于处理已发布产品和 API 的入局流量的运行时功能。 通常,只有发现的具有 datapower-api-gateway Gateway 类型的 Gateway 服务才被视为兼容。
      • 使用所有兼容网关服务: 单击此选项以使用所有已发现的兼容网关服务。
      • 选择兼容网关服务: 单击此选项以选择您选择的一个或多个兼容网关服务。 (禁用了不兼容的网关类型。)
      目录,空间和网关的示例设置
    4. API 使用设置下,使用 编辑 链接来定义如何为使用者打包 API 以及管理 API 使用情况。
      目标产品
      指定要包含 API 的产品。
      • 生成自动产品: 单击此选项以使用自动生成的产品。 此产品的名称在 " API 网关设置 " 面板中显示为 API title auto product ,其中 API 标题 表示流名称。 (如后所述,此名称在 API Connect 实例中有所不同。)
      • 现有产品: 单击此选项以从所选目录中选择现有产品。
      目标产品速率限制
      如果选择发布到自动生成的产品,请配置速率限制以控制对 API 的调用。 此速率限制将应用于自动生成的产品中的缺省计划,并且将在计划中的所有操作之间共享。
      • 无限制: 单击此选项以允许不受限的调用。
      • 定制: 单击此选项以定义一个时间段内的指定调用数。

      如果选择了现有产品,那么将禁用 目标产品速率限制 选项。 而是应用在所选产品和计划中配置的速率限制。

      提示: 您还可以使用 API 流中的 网关 选项卡在 API 组合件流中的任何位置添加 Rate Limit 策略,以在 API 组合件中定义更详细的速率限制。
      目标计划

      如果选择了现有产品,请选择所选应用程序可以预订并使用 API 的关联计划。

      如果选择发布到自动生成的产品,那么应用程序将自动预订此产品中的缺省计划,并且您无法更改此设置。

      测试应用程序
      选择要预订所选计划以使用 API 的应用程序。
      • 使用内置测试程序: 选择此选项可使用预先提供的测试应用程序。 仅当您选择使用沙箱目录时,此选项才可用。
      • 选择现有应用程序: 选择此选项可选择所选目录中手动创建的现有应用程序。 (如果您具有 Developer Portal 站点,那么将在与所选目录关联的门户网站中注册此应用程序。)
      测试使用者组织

      缺省情况下,将在此处显示拥有所选应用程序的使用者组织。

      产品,计划和应用程序的示例设置
    5. 单击 保存 以保存设置。
      您的发布首选项会在流量的整个生命周期内保存在 App Connect. 当您停止并重新启动 API 时,或者当您禁用然后重新启用统一编写时,将保留首选项。
  16. 您可以运行流,以便观察其行为。

结果

App Connect 设计器仪表板中显示为磁贴。 您可以使用磁贴管理您的 API。 管理 API 的可用选项取决于您的计划和 API 的状态。 更多信息,请参阅开发过程中的流量管理

下一步操作

  • 如果您使用的是 VPC hours 计划,您 可以在部署之前测试 API 的行为。 有关详细信息,请参阅测试 API(VPC 小时计划)
    注: 如果启用了统一编写,并且您在为流设置发布首选项之前启动流,那么将使用为流保存的最后一组用户首选项。 如果之前没有设置首选项,API 将发布到您发现的任何实例中的沙盒目录中自动生成的产品的默认计划中。 API Connect 实例。 因此,要控制 API 的发布位置,必须确保在启动 API 之前指定首选设置。
    测试 API 时,API 编辑器中会出现 Test 选项卡。
    应用程序接口测试 "选项卡的 "概览 "页面
    OpenAPI 3.0 YAML 中的运行 API 流程定义用于将 API 自动发布到指定目录和提供商组织中的产品和计划。 App Connect 中运行的 API 流的 YAML 定义用于将 API 自动发布到指定目录中的产品和计划,以及您的 API Connect 实例中的产品和计划。 如果配置了 Developer Portal ,那么 API 产品也会在其中显示。
    注: 如果启用了统一编写,那么将根据您的首选项将 API 添加到自动生成的产品或您选择的现有产品的独立版本。 已发布的产品仅包含您的 API。
  • 当您准备好在生产环境中运行流程时,就可以进行部署。 更多信息,请参阅部署集成

API Connect 中访问已发布的 API

关于本任务

如果启用了统一授权,当 API 运行时,您可以访问 API Connect 实例,以便在 API 管理器和开发人员门户中查看已发布的 API。
小贴士如果在 "API Connect中看不到 "App Connect应用程序接口,而您在一段时间前启用了集成创作功能,请禁用集成创作功能,保存更改,然后重新启用。

过程

要在 API Connect中访问 API ,请完成以下步骤。

  1. API Connect 实例中,打开 API 管理器用户界面。
  2. 在导航窗格中,单击管理图标 “管理”图标
  3. 在 " 管理 " 页面上,选择您选择发布到的沙箱或用户定义的目录。
    产品 选项卡上,您可以看到包含 API 的已发布产品。 产品标题和名称源于原始 API 流程的名称,还包括对 App Connect. 如果选择发布到自动生成的产品,那么产品版本将作为 0.0.1提供。 如果选择发布到现有产品的独立版本,那么将继承该产品版本。
    • 如果选择发布到自动生成的产品,那么产品标题将显示为 API_flow_name (Created by App Connect Designer),名称将显示为 api-flow-name-created-by-app-connect-designer
    • 如果选择发布到现有产品,那么产品标题将显示为 Product name - API_flow_name (Created by App Connect Designer),名称将显示为 product-name-api-flow-name-created-by-app-connect-designer
    已在 API Manager UI 中发布 API
  4. 可选项: 要使用应用程序接口(有限),请单击选项图标 “选项”图标 并选择相应的菜单选项。
    例如,您可以选择 管理 API 以查看 API 的基本端点,也可以查看预订。 您还可以使用 分析 选项卡来查看有关 API 调用的分析。
    限制: 不能在 API Connect 中的相应 API 正在运行时,才会出现在 API 管理器用户界面中。 App Connect 运行时才会存在于 API 管理器 UI 中。 当您在 App Connect 中停止 API 时,产品会自动从目录中删除。
  5. 可选项: 如果可以访问为指定目录启用的开发人员门户,则使用门户 URL (在 API 管理器的目录设置下)打开开发人员门户网站。
    从 API 管理器用户界面的沙盒目录设置中找到门户 URL
    在 Developer Portal 中,单击 API 产品 以浏览已发布的 API 产品。
    在 Developer Portal 中发布的产品和 API
    您可以单击磁贴上的产品名称或 API 名称以查看 API 的计划详细信息或 OpenAPI 定义,或者测试 API。
    Developer Portal 中 API 的 OpenAPI 定义

    有关更多信息,请参阅开发人员门户中的 Exploring APIs and Products(探索 API 和产品)API Connect 文档。

    限制: API 产品只存在于开发人员门户中,同时相应的 API in App Connect 运行时,API 产品才会存在于开发人员门户网站中。 当您在 App Connect 中停止 API 时,API 产品会自动从门户中删除。