跳到主要内容

接口调试功能简介

调试接口是指在开发或测试阶段针对接口发起请求,它主要用于帮助开发人员定位和修复代码中的问题。接口在调试阶段应设置详细的调试响应信息,例如错误代码、堆栈跟踪等,这些信息对于开发人员来说非常有用。

调试工作流

接口调试工作常见于针对于单个接口的调试,其工作流如下:

  1. 选择接口,进入接口“运行”页。

  1. 输入接口请求参数,然后点击“运行”按钮。

  1. 得到返回响应。你可以将请求的参数暂存接口,方便反复调试。

配置调试环境

一个项目在不同的阶段会处于不同的环境,例如存在开发环境、测试环境、生产环境等,这些环境对应着不同的“前置 URL”与“接口参数值”。“环境管理”功能将有效解决因环境变更而产生的问题,详细说明请参考《环境管理》

调试模式

调试模式适合习惯于先行进行接口参数调试,再生成接口文档的团队。在调试模式下,开发者只需要编辑界面中接口参数,修改后即可直接发送请求,保存后生成文档。

使用快捷请求

快捷请求常用于调试外部接口,无需创建接口文档便能够快速发起请求并得到响应结果。你可以阅读《快捷请求》了解更多。