调试API

最近更新时间:2020-12-25 11:12:46

查看PDF

操作场景

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

  • 后端路径中含有环境变量的API,不支持调试。
  • API绑定签名密钥时,不支持调试。
  • 如果API已绑定流控策略,在调试API时,流控策略无效。

前提条件

  • 已创建API分组和分组内的API。
  • 已搭建完成后端服务。

操作说明

(1)登录API网关控制台,点击菜单 开放API> API管理,进入到API管理信息页面。

(2)通过以下任意一种方法,进入API调试页面。

  • 在待调试的API所在行,在操作列点击 调试按钮。
  • 单击“API名称”,进入API详情页面。在页面右上角单击“调试”。
    image.png

(3)添加请求参数后,单击“发送请求”。
右侧返回结果回显区域打印API调用的Response信息。

  • 调用成功时,返回HTTP状态码为“200”和Response信息。
  • 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误代码表
    image.png

后续步骤

完成以上定义后和初步调试后,您就完成了 API 的创建。您可以发布 API 到测试、预发、线上环境,继续调试或供用户使用。还可以为 API 绑定 签名密钥、访问控制 和 流量控制 等安全配置。

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈