调试API
操作场景
API创建后需要验证服务是否正常,管理控制台提供调试功能,您可以添加HTTP头部参数与body体参数,调试API接口。
![](https://support.huaweicloud.com/usermanual-dataartsstudio/public_sys-resources/note_3.0-zh-cn.png)
- 后端路径中含有环境变量的API,不支持调试。
- API绑定签名密钥时,不支持调试。
- 如果API已绑定流控策略,在调试API时,流控策略无效。
前提条件
- 已创建API。
- 已搭建完成后端服务。
操作步骤
- 在DataArts Studio控制台首页,选择对应工作空间的“数据服务”模块,进入数据服务页面。
- 在左侧导航栏选择服务版本(例如:专享版),进入总览页。
- 单击“开发API > API管理”,进入到API管理信息页面。
- 通过以下任意一种方法,进入API调试页面。
- 在待调试的API所在行,单击“更多 > 调试”。
- 单击“API名称”,进入API详情页面,单击“调试”。
左侧为API请求参数配置区域,参数说明如表1所示。右侧为API发送的请求信息和API请求调用后的返回结果回显。
不同类型的请求,调试界面展现的信息项有差异。
- 添加请求参数后,单击“开始测试”。
- 调用成功时,返回HTTP状态码为“200”和Response信息。
- 调用超过默认30秒无结果时,会报超时错误。
- 调试失败时,返回HTTP状态码为4xx或5xx。
- 您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
如果需要修改API参数,请在右上角单击“编辑”,进入API编辑页面。
后续操作
API调试成功后,您可以将API发布,具体操作请参见发布API,以便API调用者调用。