暂存草稿产品

在发布前,将产品草稿阶段化到目录中,以创建该产品的特定版本。 当产品处于 "已登台" 状态时,任何开发者都无法看到该产品,也无法预订该产品。 IBM® API Connect 中的联合功能意味着,如果为目录启用了 空间 ,那么只能将产品登台到该目录中的 空间

准备工作

确保您在 API ManagerAPI Designer 用户界面 (UI) 中具有要登台到的目录。 有关更多信息,请参阅 创建和配置目录
注: 除非另有指定,否则本主题中对目录的所有引用也可以应用于目录中的 空间 。 有关 Spaces 的更多信息,请参阅 API Connect 中使用联合。

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

关于此任务

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

在 API Designer 中离线工作时,暂存功能不可用。

目录是一个暂存目标,它的行为就像一个逻辑分区,可以从目录和开发人员门户中分离出来。 DataPower® Gateway开发人员门户的逻辑分区。

您需要对产品进行阶段划分,以便在组织内部对其进行适当的审批,并发布产品。 有关为目录配置产品生命周期审批的更多信息,请参阅创建和配置目录。 有关批准请求的更多信息,请参阅批准产品生命周期和订阅请求 有关发布产品的更多信息,请参阅发布产品

您不能将现有产品版本重新导入生产目录。 如果更新 API,那么必须创建此 API 的新版本。 然后,创建产品的新版本,使其包含较新版本的 API。 有关创建新版本的 API 和产品的更多信息,请参阅 创建新版本的 API 定义创建新版本的产品。 如果在生产目录中启用了 " 空间 ",则无法将相同的 API 或产品版本重新导入目录中的任何 " 空间 "。 不过,您可以将产品版本重新放置到沙盒目录或其他非生产目录中,以方便迭代测试。
注意: 将产品版本重置为非生产目录时,现有应用程序订阅将被删除。 删除订阅是为了便于在持续集成环境中使用脚本进行部署,其中应用程序订阅的重新创建将由脚本控制。
如果在非生产目录中启用了空间 ,并且您将产品版本重新暂存到与之前暂存的空间不同的空间 ,则它将从之前的空间中移除并暂存到新指定的空间如果在产品中启用了计费集成,那么无法将同一产品版本重新暂存到非生产目录或生产目录。 有关计费集成的更多信息,请参阅 对产品进行货币化
在登台或发布过程中,将对 API 定义文件进行验证。 将进行以下验证:
  • 使用 API Dev Tools Swagger Parser (https://www.npmjs.com/package/@apidevtools/swagger-parser) 针对 OpenAPI 模式进行验证。
  • 针对 IBM 扩展属性进行验证。
  • 语义验证,这包括以下类型的验证:
    • 确保如果 OpenAPIAPI Connect Gateway 执行,则方案必须是 HTTPS ,或者头中 API 密钥安全方案的参数名称必须是 X-IBM-Client-IdX-IBM-Client-Secret
    • 确保如果 API Connect 网关未实施 OpenAPI ,那么必须提供 主机
    • 取消引用定义文件中的本地引用 (即 $ref 属性的值) ,并确保这些是文件中的有效 JSON 指针。
注: 如果定义 API 的 OpenAPI 文件使用 $ref 字段来引用在单独文件中定义的 OpenAPI 代码片段,那么在登台或发布包含 API 的产品之前, $ref 字段将替换为目标文件的内容 (仅当您使用 API Connect 开发者工具箱时,才支持 $ref 字段)。 有关更多信息,请参阅 使用 $ref 在 OpenAPI 文件中复用代码片段

过程

要对产品执行暂存操作,请完成以下步骤:

  1. 可选: 如果您在多个提供者组织上具有帐户,那么可以从 组织 菜单中选择要登台和发布的新提供者组织。
  2. 在导航窗格中,单击 导航窗格中的 "开发" 图标 Develop
  3. 选择 产品 选项卡。
  4. 您可以从 " 开发 " 列表页面或从产品本身登台产品。
    1. 要从 "开发列表 "页面对产品进行分期,请单击所需产品版本旁边的选项菜单图标 “选项”图标 ,然后选择 " 分期 "。
    2. 要通过产品自身暂存产品,请完成以下步骤:
      1. 单击想要使用的产品版本。
      2. 单击选项菜单图标:
        突出显示选项菜单图标的截屏
      3. 选择 阶段
  5. 选择要将产品暂存到的目录。
  6. 如果已在所选目录中启用 空间 ,请选择所需的 空间
    注: 可以从中选择的目录是为您所连接的管理服务器和提供者组织定义的目录。

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

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

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

结果

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

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

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

有关为目录配置产品生命周期审批的更多信息,请参阅创建和配置目录。 有关批准请求的更多信息,请参阅批准产品生命周期和订阅请求

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

后续操作

  • 发布您的产品,以便应用程序开发人员在开发人员门户网站上访问。 更多信息,请参阅发布产品