使用 Developer Portal 测试工具测试 API

您可以在无需编写任何代码的情况下,使用 Developer Portal 测试工具来测试 API 的行为。您可以提供测试工具内必需的 API 参数,然后单击调用以查看响应。

开始之前

要将 Developer Portal 测试工具用于需要应用程序客户机标识的 API,请完成以下任务:

关于此任务

Developer Portal 测试工具是一款交互式 API 文档测试工具。如果要测试的操作不需要客户机标识,那么无需登录即可使用 Developer Portal 测试工具。但是,如果要交互的操作需要客户机标识,那么必须先登录 Developer Portal

使用 Developer Portal 测试工具受制于应用于操作或计划的速率限制。例如,如果某个操作的速率限制为每分钟 10 个请求,并且您调用了此操作,那么可以发出的请求数将减少为 9 个。 在一分钟时间间隔内每次单击调用时都会触发限制。此警告会影响被选作用于 Developer Portal 测试工具的应用程序配额,但不影响使用相同操作或计划的其他应用程序的配额。

要测试 Developer Portal 中的 API,必须在 API Manager 中选中允许测试该 API 复选框。有关更多信息,请参阅创建 API 定义

限制:
  • 您无法使用 Developer Portal 测试工具在 OAuth 提供者 API 中测试“隐式”或“授权代码”授权类型。在相同 OAuth 提供者 API 中测试其他授权类型。
  • 您不能将 Developer Portal 测试工具用于暂挂的应用程序。
  • 如果 testable=true,并且如果现有 API 实施 CORS 并且正在使用 HTTPS,那么只可以测试未实施的 API。

过程

  1. 要将 Developer Portal 测试工具用于不需要应用程序客户机标识的 API,请完成以下步骤:
    1. 单击 API 这样会显示可供应用程序开发者使用的所有 API。
    2. 单击要测试的 API 的名称。
    3. 可在 API 操作标题下查找要使用的操作。
    4. 单击试用此操作
    5. 提供必需头或参数的值。
    6. 如果使用基本认证来保护操作,请提供凭证。
    7. 单击发送请求 结果将显示在响应主体字段中。您可以根据需要继续测试不同的参数值。
      注: 首次单击试用此操作时,可能会出现一个安全性错误。从“请求 URL”字段中复制 URL,在浏览器窗口中打开该 URL,然后接受安全性证书。这样,将不会再出现安全性错误。
  2. 要将 Developer Portal 测试工具用于需要应用程序客户机标识的 API,请完成以下步骤:
    1. 登录到 Developer Portal
    2. 如果尚未创建应用程序,那么必须创建一个应用程序,以便可以测试需要客户机标识的 API。要了解更多信息,请参阅注册应用程序
    3. 确保您的应用程序已预订包含要测试的 API 的计划。 要了解更多信息,请参阅在 Developer Portal 中浏览 API 和产品
    4. 单击 API 这样会显示可供应用程序开发者使用的所有 API。
    5. 单击要测试的 API
    6. API 操作标题和安全性副标题下,单击客户机标识(API 密钥)提供凭证 这将显示“API 密钥标识”窗口。
    7. 使用注册应用程序以选择客户机标识下拉列表,选择用于测试 API 的应用程序。
    8. 单击保存凭证
    9. 如果需要客户机密钥,请在客户机密钥字段中输入值。
    10. API 操作标题下查找要测试的操作,然后单击尝试此操作
    11. 提供所需参数和值。
    12. 如果使用基本认证来保护操作,请提供凭证。
    13. 单击发送请求 结果将显示在“响应”部分中。您可以根据需要继续测试不同的字段值。
      注: 首次单击调用时,可能会出现一个安全性错误。单击所提供的链接以接受安全证书。这样,将不会再出现安全性错误。
时间戳记图标 上次更新时间:2019-06-21