发送 API 请求

填写字段，为要在“测试”选项卡上调试的 API 设置请求。

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

打开“测试”选项卡

  1. 登录到 API Manager 或 API Designer。
  2. 在导航列表中，单击 "开发" 图标 开发，然后选择 API 选项卡。
  3. 单击要测试的 API 的标题。
  4. 在 "API 设计 " 页面上，单击页面标题中的 测试 选项卡。

填写 "请求" 部分

使用页面的请求部分来设置请求 URL、认证机制和请求参数。 完成以下步骤以填写配置请求所需的字段。

注: "测试" 选项卡不支持虚端点; 您必须指定在其中调用 API 的网关端点。 缺省情况下， 请求 字段使用网关端点。
  1. 要填充安全方案，请完成以下步骤:
    1. 单击 授权 ，然后选择所需的安全性定义。 可用的安全性定义取决于 API 中已配置的安全性方案。 要了解如何配置安全方案，请参阅 定义安全方案。 可用的安全性定义为:
      • API 密钥
      • 基本
      • OAuth
    2. 如果 API 定义将 API 密钥授权用于安全设置，请在 " 授权 " 页面上的以下字段中输入必要的授权详细信息:
      名称
      从安全方案自动填充的变量名称。
      位置
      位置是根据安全方案自动填充的。
      值
      用户可以根据自动填充的名称输入值。 例如，如果名称为 X-IBM-Client-Id ，那么用户可以在值字段中输入相同的名称。
      有关 API 密钥安全方案的更多信息，请参阅 定义 API 密钥安全方案。
    3. 如果 API 定义将基本授权用于安全设置，请在 " 授权 " 页面上的以下字段中输入必要的授权详细信息:
      用户名和密码
      输入向用户注册表进行认证所需的用户名和密码。
      有关基本安全方案的更多信息，请参阅 定义基本认证安全方案。
    4. 如果 API 定义将 OAuth 授权用于安全设置，请在 " 授权 " 页面上的以下字段中输入必要的授权详细信息:
      注：
      • OAuth 授权仅支持本机 OAuth 提供者。 有关本机 OAuth 提供者的更多信息，请参阅 配置本机 OAuth 提供者
      • OAuth 授权的可用流选项包括:
        • 隐式
        • 访问代码
        • 资源所有者 - 密码
        • 应用程序
        " 授权 " 页面上的字段基于配置的流。 例如，在密码流中， URL 字段不可用。
      授权 URL
      URL 用于重定向用户进行身份验证和授权。 URL 会自动从您在 “资源”页面中创建的OAuth Provider中填充。
      名称
      将自动填充 OAuth 提供者的名称。
      客户机标识
      此标识用于认证和授权客户机对资源的访问权。 它是根据您在 目标配置下选择的应用程序自动填充的。 有关更多信息，请参阅 指定 API 的测试首选项。
      客户机密钥
      输入对应于客户机标识的密钥。 创建应用程序时，仅显示一次客户机密钥。 记下 OAuth 授权的密钥。
      流
      API 授权中的流是指用于确定获取授权过程的 OAuth 流类型。 这取决于您在为授权创建安全方案时选择的流类型。 缺省情况下会自动填充此字段。
      作用域
      选中要添加的作用域的复选框。 作用域包含在从 OAuth 提供者生成的访问令牌中。 调用 OAuth 保护的 API 时，网关会检查访问令牌中包含的作用域。 然后，它将它们与安全性定义中允许的作用域列表进行比较，以确定是否授予访问权。
      令牌 URL
      URL 用于在认证过程中获取OAuth令牌。 URL 会根据您在“资源”页面创建相应OAuth提供商时添加URL 自动填充。
      重定向 URI
      从列表中选择重定向 URI。
      用户名和密码
      输入在 " 资源 " 页面上的相应 OAuth 提供者下选择的用户注册表的用户名和密码。

      单击 获取令牌 以创建访问令牌。

      应用授权时，系统会自动更新 参数 选项卡中的访问令牌。

      有关 OAuth 安全方案的更多信息，请参阅 定义 OAuth2 安全方案。

    5. 单击应用。

      调用 API 时， API Connect 会使用提供的信息填充头。

  2. 选择一项操作，并从提供的列表中获取URL。
  3. 在 参数 选项卡上，定义头，查询和路径参数。

    提供了空行供您定义参数，在 键 字段中输入参数名称，在 位于 字段中适当选择 query， header或 path ，并在 值 字段中提供字符串值。 开始定义新参数时，系统会自动添加另一个空行。

    已提供缺省头参数和值。 例如，如果应用程序接口应用了客户 ID 或客户机密定义，相应的密钥会作为头参数添加，并预设值；有关配置客户 ID 和客户安全定义的详情，请参阅创建 API 密钥安全定义。

    下表列出了请求中使用的一些常见头定义：

    表 1. 常用请求头
    键 值 注释
    Accepts media_type/subtype 指定响应头应使用的 Content-Type。 缺省值为 application/json。
    X-IBM-Client-Id 客户机标识 如果在沙箱目录中使用内置测试应用程序，那么系统会自动预填充值。 如果使用自己的客户机应用程序，请将值替换为您的应用程序的客户机标识。
    X-IBM-Client-Secret 客户机秘密值 如果在沙箱目录中使用内置测试应用程序，那么系统会自动预填充值。 如果使用自己的客户机应用程序，请将值替换为您的应用程序的客户机私钥。
    授权 不记名 access_token 采用 base64 对令牌进行编码。 API Connect 无法为您对令牌进行编码。
    Content-Type media_type/subtype 指定响应主体应使用的内容类型；例如，application/json 或 image/png。

    如果 API 定义了路径或查询参数，那么会将这些参数添加到参数列表中，以供您提供值; 有关配置路径和查询参数的详细信息，请参阅 定义 REST API 的路径 和 配置操作。

  4. 如果操作是 POST 或 PUT，请设置请求主体。
    1. 单击 主体 选项卡。
    2. 输入请求主体的信息。

发送请求

配置 API 请求时，单击发送以执行调用。

如果显示的消息指示“无响应”，那么无法完成 API 调用。 此问题的可能原因如下:

  • 未在 API 定义中启用 CORS

    编辑 API 定义并启用 CORS。 然后，保存更改并发布 API。 如果使用自己的客户机应用程序，请记住在发布后再次针对 API 预订应用程序。

  • 网关服务 URL 的证书无效

    请遵循指示信息以接受证书并继续测试。

  • 浏览器无法连接到网关服务