今天來串接我們的咖啡廳資料到 App 上。首先來簡單地確認 API有沒有問題,沒有問題在繼續往後做。會先用最簡單的 JsonParser 看看資料結構,接著再使用 Postman 測試 API。最後,我們會使用 OKHttp 串接至 App 上。
這是全台咖啡廳 API 文件,是一個開源的 API。我們直接使用最新版的 v1.2,相較於舊版,有多兩個資訊欄位,分別為捷運站以及營業時間,文件內有 API 網址和各個欄位的說明。
先來瞧瞧全台灣咖啡廳資料的 API 長相
http://cafenomad.tw/api/v1.2/cafes
文件內有提到,若想要其他城市的資料,只需在網址後面加上城市名稱即可。
台北的咖啡廳資料 :
http://cafenomad.tw/api/v1.2/cafes/taipei
桃園的咖啡廳資料 :
https://cafenomad.tw/api/v1.2/cafes/taoyuan
來看一眼直接點擊 http://cafenomad.tw/api/v1.2/cafes/taipei
後的資料結構
不行吧完全不想看,試著美化一下吧~
將程式碼貼到 JsonParser 上,這是一個線上的 Json 字串轉換器,想要簡單測試的話滿方便的~
可以看到我們會拿到一包資料,裡面是 Json array,打開來就可以看到對應的 key、value。
可是大部分在實務上不太會在網頁上測試 API,或是要測試的 API 不是 GET
的話,那就需要用到 API 測試工具。
筆者在工作時大多是搭配 Postman 來測試後端開發的 API,我的訴求只要介面簡單又好上手即可。
如果還沒有的朋友,可以先到這邊下載和註冊 Postman 帳號。
下載完成後,直接點擊 New
來新增 HTTP request
完成後的預設畫面
環境都設定好了,直接輸入要測試的台北咖啡廳 URL,點擊 Send
即可看到撈回來的資料。
這邊值得注意的是我們的 Http method 是 GET
,如果想改成其他的方法像是 POST
也可以直接切換~
測試成功,來確認資料結構,將回傳結果比對文件上的說明,看來目前需要的資料像是咖啡廳名稱、 URL、WIFI、地址等等都有。
API 測試完成,可以繼續往下走拉! 明天就來試著串接到我們的 App 內~~