调试API
操作场景
API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。
![](https://support.huaweicloud.com/usermanual-apig/public_sys-resources/note_3.0-zh-cn.png)
- 后端路径中含有环境变量的API,不支持调试。
- 如果API已绑定流控策略,在调试API时,流控策略无效。
前提条件
- 已创建API分组和分组内的API。
- 已搭建完成后端服务。
操作步骤
- 进入共享版控制台。
- 单击“开放API > API管理”,进入到API管理信息页面。
- 通过以下任意一种方法,进入API调试页面。
- 在待调试的API所在行,单击“更多 > 调试”。
- 单击“API名称”,进入API详情页面。在右上角单击“调试”。
图1 调试界面左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。
表1 调试API 参数名称
说明
协议
仅在API请求的“请求协议”为“HTTP&HTTPS”时,支持修改。
方法
仅在API请求的“Method”定义为“ANY”时,支持修改。
后缀
仅在API请求的“匹配模式”为“前缀模式”时,支持自定义路径。
路径
API的请求path。
路径参数
仅在API请求的“请求Path”中存在“{}”时,支持修改。
查询参数
Query的参数与参数值。
请求头
HTTP Headers的参数与参数值。
请求体
仅在API请求的“Method”定义为“PATCH”/“POST”/“PUT”时,支持修改。
不同类型的请求,调试界面展现的信息项有差异。
- 添加请求参数后,单击“发送请求”。
右侧返回结果回显区域打印API调用的Response信息。
- 调用成功时,返回HTTP状态码为“200”和Response信息。
- 调试失败时,返回HTTP状态码为4xx或5xx,具体错误信息请参见错误码。
- 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
如果需要修改API参数,请在右上角单击“编辑”,进入API编辑页面。