使用 Developer Portal 测试工具测试 API

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

开始之前

要将 开发者门户网站 测试工具与需要应用程序客户机标识的 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 中测试其他授权类型。 如果 OAuth 提供者允许从测试工具正常运行这些操作，那么可以禁用此选项。 有关更多信息，请参阅 禁用测试工具限制。
  • 不能将 Developer Portal 测试工具与暂挂的应用程序配合使用。
  • 如果 testable=true，并且如果现有 API 实施 CORS 并且正在使用 HTTPS，那么只可以测试未实施的 API。
注: 可以从 Developer Portal 用户界面测试 GraphQL API。 但是，并非所有认证方法都受支持。 必须使用以下认证方法之一：
  • 不受保护
  • 客户机标识，在头中传递
  • 客户机标识和秘钥，在头中传递
此外，不支持 cost 度量，并且不会在产品计划中列示特定于 GraphQL 的速率限制。

过程

  1. 要将 Developer Portal 测试工具与不需要应用程序客户机标识的 API 配合使用，请完成以下步骤:
    1. 单击 API 产品。
      这样会显示应用程序开发者可使用的所有 API。
    2. 单击要测试的 API 的名称。
    3. 选择操作，然后选择 试用。
    4. 单击 尝试此操作。
    5. 提供必需头或参数的值。
    6. 如果使用基本认证来保护操作，请提供凭证。
    7. 单击 发送请求。
      结果将显示在响应主体字段中。 您可以根据需要继续测试不同的参数值。
      注：

      首次单击试用时，可能会出现安全性错误。 从“请求 URL”字段中复制 URL，在浏览器窗口中打开该 URL，然后接受安全性证书。 这样，将不会再出现安全性错误。

      此外，出于性能原因，如果有效内容很大（超过 1500 个 DOM 突出显示的元素），那么您将获得响应，但它不会整齐列显。

  2. 要将 Developer Portal 测试工具与需要应用程序的客户机标识的 API 配合使用，请完成以下步骤:
    1. 登录到 Developer Portal。
    2. 如果尚未创建应用程序，那么必须创建一个应用程序，以便可以测试需要客户机标识的 API。 有关更多信息，请参阅 注册应用程序。
    3. 确保您的应用程序已预订包含要测试的 API 的计划。 有关更多信息，请参阅 在 Developer Portal 中浏览 API 和产品。
    4. 单击 API 产品。
      这样会显示应用程序开发者可使用的所有 API。
    5. 单击要测试的 API 。
    6. 选择 Provide credentials for Client ID (API Key) 操作，然后选择 尝试。
      这将显示“API 密钥标识”窗口。
    7. 使用 注册应用程序以选择客户机标识 下拉列表来选择要用于测试 API 的应用程序。
    8. 单击 保存凭证。
    9. 如果需要客户机密钥，请在 客户机密钥 字段中输入值。
    10. 查找要测试的操作，然后单击 试用。
    11. 提供所需参数和值。
    12. 如果使用基本认证来保护操作，请提供凭证。
    13. 单击 发送。
      结果将显示在“响应”部分中。 您可以根据需要继续测试不同的字段值。
      注: 第一次单击 调用时，可能会显示安全性错误。 单击所提供的链接以接受安全证书。 这样，将不会再出现安全性错误。