暂存草稿产品
将草稿产品暂存至目录,以在发布前创建该产品的特定版本。 当产品处于 "已登台" 状态时,任何开发者都无法看到该产品,也无法预订该产品。 IBM® API Connect 中的联合功能意味着,如果为目录启用了 空间 ,那么只能将产品登台到该目录中的 空间 。
准备工作
要完成本主题中描述的产品管理任务,您必须是 API 提供者组织的所有者,或者被分配对目标目录或 空间的 产品> 阶段 许可权。 有关为目录或 空间配置产品管理许可权的信息,请参阅 创建和配置目录 或 在空间中管理用户访问权。
关于此任务
目录是一个暂存目标,在 DataPower® Gateway 和开发人员门户网站之间的逻辑分区。
将产品暂存,以便可为其提供在组织内以内部方式进行的相应核准,从而发布该产品。 有关为目录配置产品生命周期核准的信息,请参阅 创建和配置目录。 有关核准请求的信息,请参阅 核准产品生命周期和预订请求。 有关发布产品的信息,请参阅 发布产品。
无法将现有产品版本重新暂存到生产目录。 如果更新 API,那么必须创建此 API 的新版本。 然后,创建产品的新版本,使其包含较新版本的 API。 有关创建新版本的 API 和产品的更多信息,请参阅 创建新版本的 API 定义 和 创建新版本的产品。 如果在生产目录中启用了 空间 ,那么无法将同一 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 指针。
- 确保如果一个 OpenAPI 由一个 API Connect 网关 强制执行,则该方案必须是 HTTPS ,或者标题中API密钥安全方案的参数名称必须是
$ref 字段来引用在单独文件中定义的 OpenAPI 代码片段,那么在登台或发布包含 API 的产品之前, $ref 字段将替换为目标文件的内容 (仅当您使用 API Connect 开发者工具箱时,才支持 $ref 字段)。 有关更多信息,请参阅 使用 $ref 在 OpenAPI 文件中复用代码片段。过程
要对产品执行暂存操作,请完成以下步骤:
结果
您的产品已暂存到目录。 您可以在 API Manager中查看目录中产品的状态。 如果已从 API Designer登台产品,请确保使用用于 API Designer 的相同用户名和密码登录到 API Manager 。 在 API Manager UI 中单击
管理 ,然后选择所需的目录。 这将显示状态为已暂存的产品。
有关产品生命周期的信息,请参阅 产品生命周期。
如果在该目录中,需要经过核准才能对产品执行暂存操作,那么在发送核准请求后,该产品将转变为“暂挂”状态;当请求通过核准后,便会暂存该产品。 如果不需要核准,那么将立即暂存该产品。
有关为目录配置产品生命周期核准的信息,请参阅 创建和配置目录。 有关核准请求的信息,请参阅 核准产品生命周期和预订请求。
如果产品不包含任何计划,那么会将称为 "缺省计划" 的计划自动添加到目录中的产品。
后续操作
- 发布产品,供应用程序开发者在 Developer Portal中访问该产品。 有关更多信息,请参阅 发布产品。