iT邦幫忙

第 11 屆 iThome 鐵人賽

DAY 9
0
Modern Web

Golang - 從打造一個 API 開始學起系列 第 9

[Day09] web api

本文同步發表於: Sponge Records

WEB API,這是這系列文章的重點,我們將要使用 golang 來完成一個具備會員註冊、登入、報表呈現的 WEB API
而所謂 WEB API 是什麼呢? 現在將會簡單的介紹與規劃我們的 API 需要具備的功能跟 URL 路徑

所謂的 WEB API 簡單且通俗來講,就是沒有頁面的網站,資訊傳遞都透過 JSON/XML 格式的文字來傳遞
而為什麼不直接做成網站就好了,還需要另外設計一個頁面來跟這個 WEB API 互動來達到功能呢?
我這裡提出的看法是可以分開介面跟功能,意思是假設我想要做手機端、網站端、電腦端,我只需要做一個功能端就好
其他客戶端口都是分開,降低維護成本,只需要維護各自的介面就好了

API 的架構

在介紹 postman 時,在 [Day03] postman web api 測試工具安裝的文章中,有實際連接 get、post 方法,因此我們會需要設定 url
而用 URL 來區分不同功能,就是所謂路由的設計

  • 路由
    所謂的路由就是透過改變 URL 的長相來調用不同的功能,我們的 API 需要註冊、登入、報表呈現,所以會有以下的設計...

[post]註冊 url = Domain + /new
需要資訊:

  email ex.test@mail.com
  password ex.test1234

[post]登入 url = Domain + /login
需要資訊:

  email ex.test@mail.com
  password ex.test1234

[post]取得圖表列表 url = Domain + /chartList
需要資訊:

  token ex.gRMYDxkRdxyV7ek1ghhuGZQGEghjgtFDtYUmXk

[post]取得圖表詳細 url = Domain + /chartInfo

 chartID ex.a123456
 token ex.gRMYDxkRdxyV7ek1ghhuGZQGEghjgtFDtYUmXk

下回預告

下回將會介紹 api 需要如何跟資料庫互動,與講解甚麼叫 CURL


上一篇
[Day08] sql 與 postgresql 的關係
下一篇
[Day10] api 架構與套件選用
系列文
Golang - 從打造一個 API 開始學起30

尚未有邦友留言

立即登入留言