上一篇提到了 HTTP Request 多種的請求方式,像是 GET、POST、這篇就來介紹 HTTP Request 在現實中實際被應用的形式是怎麼樣的。

API 的全名是 Application Programming Interface,也就是「應用程式介面」,但這樣講其實對於剛入門的人來說可能比較難理解,所以這篇會以實作的方式來介紹 API!

API 的運作原理

基於前後端分離的特性,後端可以將處理 CRUD 的程式邏輯寫在 API 中,然後前端只要有辦法串接到 API,就能夠抓取到資料庫的資料了。基本上前端會收到的資料型態最常見的是 JSON,也有 XML、CSV 等的格式。

API 架構

API 由以下幾個元素組成

  1. Request method:GET、POST…
  2. API address:

API 會以網址的形式呈現,若有很多 API,會有一個 domain 去存放所有的 API,像是https://datacenter.taichung.gov.tw/swagger/yaml/387120000J這樣的格式

範例

這邊以台中市資料開放平台的 API 做範例,從這邊的文件可以看到每一行都是一個 API,最前面的格式

每行都可以點進去,可以看到這個 API 所需的參數和其回傳的資料格式

有的文件還會寫出錯誤的狀態碼,這時 API 就會回傳錯誤訊息