調試API
更新時間 2023-08-17 17:33:31
最近更新時間: 2023-08-17 17:33:31
分享文章
本章節主要介紹調試API。
操作場景
API創建后需要驗證服務是否正常,管理控制臺提供調試功能,您可以添加HTTP頭部參數與body體參數,調試API接口。
說明
后端路徑中含有環境變量的API,不支持調試。
API綁定簽名密鑰時,不支持調試。
如果API已綁定流控策略,在調試API時,流控策略無效。
前提條件
- 已創建API。
- 已搭建完成后端服務。
操作步驟
1.在DataArts Studio控制臺首頁,選擇實例,點擊“進入控制臺”,選擇對應工作空間的“數據服務”模塊,進入數據服務頁面。
選擇數據服務

2.在左側導航欄選擇服務版本(例如:專享版),進入總覽頁。
3.單擊“開發API > API管理”,進入到API管理信息頁面。
4.通過以下任意一種方法,進入API調試頁面。
在待調試的API所在行,單擊“更多 >調試”。
單擊“調試API”,進入API詳情頁面,單擊“調試”。
左側為API請求參數配置區域,參數說明如下表所示。右側為API發送的請求信息和API請求調用后的返回結果回顯。
調試API
| 參數名稱 | 說明 |
|---|---|
| 參數配置 | Query的參數與參數值。 |
| 集群配置 | 僅專享版支持,選擇調試API所依托的實例。 |
說明不同類型的請求,調試界面展現的信息項有差異。
5.添加請求參數后,單擊“開始測試”。
右側返回結果回顯區域打印API調用的Response信息。
?調用成功時,返回HTTP狀態碼為“200”和Response信息。
?調試失敗時,返回HTTP狀態碼為4xx或5 xx 。
6.您可以通過調整請求參數與參數值,發送不同的請求,驗證API服務。
說明如果需要修改API參數,請在右上角單擊“編輯”,進入API編輯頁面。
后續操作
API調試成功后,您可以將API發布API,以便API調用者調用。