文档首页/ API网关 APIG/ 用户指南（吉隆坡区域）/ API管理/ 调试API
更新时间：2024-08-07 GMT+08:00
查看PDF
分享

调试API

API创建后需要验证服务是否正常，管理控制台提供调试功能，您可以添加HTTP头部参数与body体参数，调试API接口。

  • 后端路径中含有环境变量的API，不支持调试。
  • 如果API绑定了插件策略或传统策略，在调试API时，策略均不生效。
  • 调试API时，后端超时时间最大支持60s。

前提条件

已搭建完成后端服务。

操作步骤

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > API分组”。
  2. 单击分组名称。
  3. 在“API运行”页签，选择待调试的API，单击“调试”。
  4. 配置URL和API请求参数。

    选择请求方法、请求协议、域名等，然后配置API请求参数。

    域名可选调试域名或独立域名。当选择的独立域名为泛域名时，需要填写泛域名的子域名。

    当独立域名为泛域名时，用户可以通过泛域名的所有子域名访问所绑定分组下的所有API。

    例如，某个泛域名为“*.aaa.com”，子域名可以为“default.aaa.com”和 “1.aaa.com”等。

  5. 单击“调试”。
  6. 在页面下方返回结果回显区域打印API调用的Response信息。

    • 调用成功时，返回HTTP状态码为“2xx”和Response信息。
    • 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参见错误码。

  7. 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。

后续操作

API调试成功后，您可以将API发布到环境，以便API调用者调用。或者出于API的安全性考虑，为API添加策略。

父主题： API管理