激活 API

创建 API 定义后，您可以将其激活以自动发布 API 文档并使其可用于测试。

关于此任务

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

激活 API 时， API Connect 会自动完成以下操作:

  • 创建草稿产品，将 API 添加到该产品，并将该产品发布到沙箱目录以便可以调用该 API。 产品标题为 api_title 自动产品。 请注意，如果您以后想要删除草稿产品，那么不能直接将其删除; 而是要删除 API ，并且草稿产品将与 API 一起删除; 请参阅 删除 API 定义。 如果要从发布该产品的任何目录中除去该产品，那么必须单独执行此操作; 请参阅 从目录中除去产品
  • 为产品预订沙箱测试应用程序，以便立即在测试环境中对 API 进行测试。 有关测试 API 的信息，请参阅 测试 API。

要激活 API，您必须已获得具有 Product:Manage 和 Subscription:Manage 许可权的角色。 缺省情况下，预先提供的开发者角色具有这些许可权；如果为您分配了定制角色，那么必须具有这些许可权。 有关更多信息，请参阅 创建定制角色。

注：
  • 如果在沙箱目录中针对“暂存”、“发布”或“替换”操作启用了生命周期核准，那么将无法成功激活 API。 如果启用了任何此类生命周期核准，那么为了能够激活 API ，必须将其禁用; 有关生命周期核准设置的信息，请参阅 创建和配置目录。
  • 要从 API Designer 用户界面激活 API ，您必须连接到管理服务器; API 激活不可用于脱机方式下的 API Designer 。 有关更多信息，请参阅 从 API Designer 登录。
  • 无法验证或发布包含具有 Swagger 属性 (使用 regex ) 的 API 的产品，其中包含诸如 "(?" 之类的前瞻断言。 系统会返回错误消息。 例如： 
    Product has not been published!
The multipart 'openapi' field contains an OpenAPI definition with validation errors.
    definitions.properties.pattern Does not match format 'regex' (context: (root).definitions.properties.pattern, line: 0, col: 0)
400

过程

要激活 API 并自动发布 API 文档，请完成以下步骤:

  1. 在导航窗格中，单击 API UI 导航窗格中的 "开发" 图标 开发，然后选择 API 选项卡。
  2. 单击要使用的 API 的标题。
  3. 在 测试选项卡下，单击 目标配置。 " 首选项 " 页面将打开。
  4. 将 自动发布 开关设置为 开启 位置: 突出显示用于发布 API 的滑块控件的截屏

结果

成功完成时， API 显示为 On:突出显示用于发布 API 的滑块控件的截屏

您可以通过将激活滑块控件移动到 关闭 位置来停止 API: 突出显示滑块控件以停止发布 API 的截屏

如果停止 API ，那么将删除应用程序预订，并从沙箱目录中除去自动产品。
注: 您可以选择所选目录，也可以通过选择 使用缺省内置沙箱目录来选择使用沙箱目录。 有关更多信息，请参阅 指定 API 的测试首选项。

如果您对 API 进行了更改，它将自动重新发布，您还可以手动重新发布正在运行的 API，方法是将其停止然后重新激活它。

错误指示器显示 API 定义的 OpenAPI 源代码中是否存在验证错误。 如果存在错误，请单击该图标以了解更多详细信息：显示存在验证错误的 API 的截屏

您还可以在创建过程中以及在 API 测试页面上激活 API; 请参阅 创建 API 定义 和 测试 API。

注: 如果 OpenAPI 3 API 包含响应通配符 (不受支持) ，那么将对该 API 禁用发布。 必须先更正问题，然后才能发布 API。