在生成API時,如果需要將API發布至API網關進行托管,您需要完成對API的測試,驗證調用API時的請求參數和返回結果是否符合預期;同時您也可以對已發布的API進行測試。本文為您介紹如何測試開發中和已發布的API。
背景信息
API測試本質上是直接訪問實際數據源或后端服務來調用API,會占用數據服務資源組產生數據服務資源組費用,計費詳情請參考數據服務計費說明。
測試開發中的API
測試開發中的API是指在服務開發頁面(即開發環境)進行測試,您需要先生成或注冊API。詳情請參見生成API概述或注冊API。
登錄DataWorks控制臺,切換至目標地域后,單擊左側導航欄的 ,在下拉框中選擇對應工作空間后單擊進入數據服務。
找到服務開發頁面的服務管理頁簽,在API管理下面的發布的API頁簽中,單擊您所測試的API操作欄中的測試。
測試API。
在API測試對話框中,輸入請求參數的值。
單擊開始測試,觸發API測試。
您可以在右側查看API的請求詳情和返回內容。
響應時長是本次API請求的響應時長,供您評估的API性能。如果延遲較大,則需要考慮進行查詢邏輯或數據源優化。
如果測試失敗,請仔細查看錯誤提示,進行相應的修改并重新測試。
測試已發布的API
測試已發布的API是指在服務管理頁面(即生產環境)進行測試,您需要先發布API。詳情請參見發布API。
在數據服務頁面,單擊上方的服務管理。
在左側導航欄,單擊API測試。
從下拉列表中選擇需要測試的API,并確認API的請求參數的值已配置完整。
單擊開始測試,在右側查看請求詳情和返回內容。
說明API測試頁面僅提供API在線測試功能,不支持更新API正常返回示例。
后續步驟
完成開發中的API測試后,您可將API提交發布,便于后續其他人調用API。發布API的操作詳情請參見發布API。