在產生API時,如果需要將API發布至API Gateway進行託管,您需要完成對API的測試,驗證調用API時的請求參數和返回結果是否符合預期;同時您也可以對發行的API進行測試。本文為您介紹如何測試開發中和發行的API。
背景資訊
API測試本質上是直接存取實際資料來源或後端服務來調用API,會佔用資料服務資源群組產生資料服務資源群組費用,計費詳情請參考資料服務公用資料服務資源群組計費說明:隨用隨付。
測試開發中的API
測試開發中的API是指在服務開發頁面(即開發環境)進行測試,您需要先產生或註冊API。
登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的資料服務,在下拉框中選擇對應工作空間後單擊進入資料服務。
在服務開發頁面的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。