Apiary 把文件與類似 postman 的功能結合在一起,可以邊看文件邊測試。
今日要點:
》Apiary 測試 API 介紹
經過前面的準備,我們可以分享給別人來測看看 API 是否正常了,你可以點選上方的 Documentation
後, 就可以看到分享的畫面。
把上面的網址貼給別人就可以來看文件和測試API了,他預設分享的網址是 你的專案名稱
.docs.apiary.io/
這裡是我的範例的 Apiary 網址 https://jasonithelp2021.docs.apiary.io/ 可以來玩看看。
Apiary 可以讓你直接測試 Api,用起來很像我們用 postman 在測 API 一樣,很方便。
首先點選下方的
再點選右上的
會看到測試的設定畫面
因為我們在 Action 有寫好 Get 的參數如下:
+ Parameters
+ name: Jason (string, optional) -查詢人的姓名
+ func: getGmailInfo (string, required) - 要呼叫的功能名稱
所以你可以看到在畫面上已經預設有二個參數了,因為 name 不是必要的參數,所以預設沒有勾選,你可以在這裡把他勾起來。
再來我們要選 server,我們先實際打到正式的 Google server 去, 所以先選 Production
選了 Production 之後,你可以看到上方的 Get 前面網址 domain name 會變為 https://script.google.com/...
如果是選了其他的如 Mock server,你可以看到上方的 Get 前面網址 domain name 會變為 https://private-anon-52ad759595-jasonithelp2021.apiary-mock.com/...
按下 Call Resource 就可以看到 Google server 回傳的結果, 預設是在 Diff 標籤,他可以幫你比對回傳值跟你在文件 Specification 打的值有沒有不一樣的地方,不一樣的地方會用綠色背景突顯出來。
你可以切到 Real 看實際的回傳樣子,下方的 Json 格式他幫你排好看一點。
如果你是用 Mock server 去打,那在上方的 Inspector 會有記錄可以查看,對模擬服務器的任何請求或響應都將被記錄在 Inspector,所以我們也可以使用喜歡的工具(例如 curl 或 Paw)來呼叫 API,細節可以查看參考所附的連結。
以上就是使用 Apiary 測試 API 的介紹了。呼~ 總算寫好了,今天有點忙... !