當consumer在編寫代碼去調用api之前,一定要知道api的入參和傳回結果的定義是什麼樣的,了解的方式基本也就是參考provider所提供的api文檔。
但是文檔上的内容都是靜态的,隻是通過參數定義說明和傳回示例的内容往往滿足不了consumer的要求,也很難覆寫每個接口的全部使用場景,這時候api網關的調試api功能可能會給您帶來幫助。
首先provider配置好api之後釋出到測試環境或者是線上環境。
api網關是基于app進行調用的,是以provider要把已經釋出的api授權給一個app。
完成以上兩步操作後,可以在 應用管理 --> 應用詳情 --> 已授權的api 中,看到調式api入口,見下圖。
!
打開調試api之後,頁面會自動加載api定義的資訊:
1)接口域名,顯示的是這個api所屬分組的自定義域名,如果分組上沒有綁定自定義域名,則顯示二級域名,二級域名不支援https調試。
2)請求參數,調用api需要的參數,包括headers、query和body,如果定義了示例值系統會自動填上。
3) app,系統會自動填充appkey和appsecret,調式的時候如果需要可以随時更換。
4) 點選“發送請求”,頁面右側會顯示調試資訊,包括request和response詳細資訊,友善使用者排查自己遇到的問題(x-ca-error-message字段為錯誤碼字段),見下圖。