暂存 API

此图形向导提供了将 API 添加至产品并在目录中暂存该产品的选项。 当产品处于“已暂存”状态时，所有开发者都无法看到或预订该产品。 IBM® API Connect 中的联合功能意味着，如果为目录启用了 空间 ，那么只能将产品登台到该目录中的 空间 。

在开始之前

确保您在 API Manager 或 API Designer 用户界面 (UI) 中具有要登台到的目录。 有关更多信息，请参阅 创建和配置目录。

确保目录至少配置一个网关服务。

注: 除非另有指定，否则本主题中对目录的所有引用也可以应用于目录中的 空间 。 有关 Spaces 的更多信息，请参阅 在 API Connect 中使用联合。

要完成本主题中描述的产品管理任务，您必须是 API 提供者组织的所有者，或者被分配对目标目录或 空间的 产品> 阶段 许可权。 有关为目录或 空间配置产品管理许可权的信息，请参阅 创建和配置目录 或 在空间中管理用户访问权。

关于此任务

您可以使用 API Designer UI 应用程序或使用基于浏览器的 API Manager UI 来完成此任务。 在 API Designer 中离线工作时，暂存不可用。

目录是一个暂存目标，在 DataPower® Gateway 和开发人员门户网站之间的逻辑分区。

在登台或发布过程中，将对 API 定义文件进行验证。 将进行以下验证：
  • 使用 API Dev Tools Swagger Parser (https://www.npmjs.com/package/@apidevtools/swagger-parser) 针对 OpenAPI 模式进行验证。
  • 针对 IBM 扩展属性进行验证。
  • 语义验证，这包括以下类型的验证：
    • 确保如果一个 OpenAPI 由一个 API Connect 网关 强制执行，则该方案必须是 HTTPS ，或者标题中API密钥安全方案的参数名称必须是 X-IBM-Client-Id 或 X-IBM-Client-Secret 。
    • 确保如果 API Connect 网关未实施 OpenAPI ，那么必须提供 主机 。
    • 取消引用定义文件中的本地引用 (即 $ref 属性的值) ，并确保这些是文件中的有效 JSON 指针。
注: 如果定义 API 的 OpenAPI 文件使用 $ref 字段来引用在单独文件中定义的 OpenAPI 代码片段，那么在登台或发布包含 API 的产品之前， $ref 字段将替换为目标文件的内容 (仅当您使用 API Connect 开发者工具箱时，才支持 $ref 字段)。 有关更多信息，请参阅 使用 $ref 在 OpenAPI 文件中复用代码片段。

过程

  1. 在导航窗格中，单击 导航窗格中的 "开发" 图标 开发，然后选择 API 选项卡。
    此时将打开 " 开发 " 页面。
  2. 可选: 如果您在多个提供者组织上具有帐户，那么可以从 组织 菜单中选择要登台和发布的新提供者组织。
  3. 您可以从 开发 列表页面或从 API 定义本身登台 API。
    1. 要从 开发 列表页面登台 API ，请单击所需 API 旁的选项菜单图标 “选项”图标 ，然后选择 阶段。
    2. 要通过 API 定义暂存 API，请完成以下步骤：
      1. 单击要使用的 API 的标题。
      2. 单击选项菜单图标:
        突出显示选项菜单图标的截屏
      3. 单击 阶段。
  4. 请选择以下操作之一：
    • 要通过将 API 添加至新产品来将此 API 暂存，请完成以下操作：
      1. 选择新产品 - 使用新产品发布。
      2. 出现提示时，请输入 标题 和 版本。
      3. 系统会自动输入产品名称。 在 CLI 命令中，将使用此名称来引用该产品。 请参阅 工具箱 CLI 参考文档。
      4. 单击下一步。
    • 要通过将 API 添加至现有产品来将此 API 暂存，请完成以下操作：
      1. 选择现有产品 - 使用现有产品发布
      2. 选择要使用的产品。
      3. 单击下一步。
  5. 在 " 登台到 " 页面上，选择要将产品登台到的目录。
    注: 可以从中选择的目录是为您所连接的管理服务器和提供者组织定义的目录。

    如果您使用的是 API管理器 用户界面，连接信息取决于您打开的 API管理器 URL 以及登录时使用的用户ID。 如果使用 API Designer 用户界面，则应在首次启动 API Designer 时打开的登录窗口中提供管理服务器详细信息和用户 ID；请参阅 Logging into API Designer.

    有关如何在提供者组织中创建目录的详细信息，请参阅 创建和配置目录。

  6. 如果在随后发布登台产品时希望仅将其发布到所选网关服务，请选择 发布到特定网关服务，然后选择所需的网关服务。 这样将仅列示其类型与产品的网关类型设置相匹配的网关服务。 有关网关类型的信息，请参阅 API Connect 网关类型.
  7. 单击 阶段。

结果

您的产品已暂存到目录。 您可以在 API Manager中查看目录中产品的状态。 如果已从 API Designer登台产品，请确保使用用于 API Designer 的相同用户名和密码登录到 API Manager 。 在 API Manager UI 中单击 API Manager UI 导航窗格中的 "管理" 图标 管理 ，然后选择所需的目录。 这将显示状态为已暂存的产品。

有关产品生命周期的信息，请参阅 产品生命周期。

如果在该目录中，需要经过核准才能对产品执行暂存操作，那么在发送核准请求后，该产品将转变为“暂挂”状态；当请求通过核准后，便会暂存该产品。 如果不需要核准，那么将立即暂存该产品。

有关为目录配置产品生命周期核准的信息，请参阅 创建和配置目录。 有关核准请求的信息，请参阅 核准产品生命周期和预订请求。

如果产品不包含任何计划，那么会将称为 "缺省计划" 的计划自动添加到目录中的产品。