指定 API 的测试首选项

缺省情况下,使用 "测试" 选项卡测试 API 时,会预先配置一系列测试参数。 例如,将自动生成缺省产品 (将 API 添加到该产品) ,并将该产品发布到沙箱目录。 但是,您可以为每个 API (包括必需的产品和目标目录) 配置测试首选项。

关于此任务

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

注: 如果您正在使用 本地 Test Environment,那么此功能不可用。

过程

  1. 通过以下任一方式打开所需的 API 以进行编辑:
    • 在初始创建 API 期间,API 向导将引导您输入最低配置设置;完成初始配置后,单击编辑 API
    • 要打开现有 API 进行编辑,请完成以下步骤:
      1. 在导航窗格中,单击 API UI 导航窗格中的 "开发" 图标 开发,然后选择 API 选项卡。
      2. 单击要使用的 API 版本的标题。
  2. 测试 选项卡下,单击 目标配置
    此时将打开 " 首选项 " 页面。
  3. 根据需要,使用 编辑 链接来配置以下测试首选项:
    自动发布
    为了执行 API 以进行测试,必须使其联机。 要使 API 联机并自动发布 API 文档,请将 自动发布 开关设置为 开启 位置。
    目标目录
    要将包含 API 的产品发布到的目录。 所选目录将用作其他首选项设置的作用域。 您可以选择所选目录,也可以通过选择 使用缺省内置沙箱目录来选择使用沙箱目录。
    目标网关服务
    要向其发布包含 API 的产品的网关服务。
    目标产品
    将包含 API 的产品; 您可以从所选 目标目录中选择任何产品,也可以通过选择 在保存时生成产品来选择使用自动生成的产品。 自动生成的产品具有标题 api_title auto product
    目标产品速率限制
    如果选择使用自动生成的产品,那么可以配置速率限制以控制对 API 的调用。 如果您选择了自己的产品,那么 目标产品速率限制 选项不可用; 而是应用所选产品和计划中配置的速率限制。
    目标计划
    您希望测试应用程序预订的所选产品中的计划。 如果选择使用自动生成的产品,那么 目标计划 选项不可用; 相反,应用程序将预订自动生成的产品中的缺省计划。
    测试应用程序
    要预订所选计划的应用程序。 您可以选择您选择的应用程序,或者,如果您选择使用沙箱目录,那么可以通过选择 使用内置测试应用程序来改为使用预先提供的测试应用程序。
    测试使用者组织
    要预订所选计划的使用者组织。 如果您选择了自己的应用程序,那么使用者组织将预设为包含该应用程序的用户组织,并且无法更改。 如果您选择使用预先提供的测试应用程序,那么可以根据需要选择您选择的使用者组织。

    单击 重置 以将首选项重置为缺省值。

  4. 完成后单击 保存首选项
    "测试" 页面标题显示以下详细信息:
    • 目标目录。
    • 目标网关服务。
    • 与当前 API 关联的目标产品。
    • 如果 API 的当前状态为 "联机" 或 "脱机"。 您可以在 API 的 "设计" 页面标题中配置此内容。

结果

下次使 API 联机时,将按首选项设置指定的方式发布 API ,以供测试。
注: 这些设置存储在浏览器的本地存储器中,并将用于后续会话中的 API 测试。 以下设置特定于每个单独的 API:
  • 目标产品
  • 目标产品速率限制
  • 目标计划
其余设置将应用于所有 API。