接下來我們想要做到的是一個 TODO list 的 RESTful API

並且會先使用 apiary.io 做規劃

實際看看感覺如何

進入網站後，註冊登入後

左上角的 dropdown list 選擇 create new API

產生後下方就會跑出範例文擋

這個網站會透過特定格式的編排自己希望的 API endpoint 及範例回傳值後，產生出一份漂亮的文件

網站中間是模式的選擇

Documentation 是實際讓其他人看的，Editor 則是編輯模式

我們就稍微簡單規劃一下 TODO List 的 RESTful API 吧!

這是我自己規劃的 文件

基本上 route 會長這個樣子:

TODOs
GET /user/{user_id}/todos/
POST /user/{user_id}/todos/
GET /user/{user_id}/todos/{id}
PUT /user/{user_id}/todos/{id}
DELETE /user/{user_id}/todos/{id}

資料格式也都在該文件整理好了

/user/{user_id}/ 只是用來辨識是哪個 user 的 todo task data

在這個小 API 不會琢磨在使用者系統的建立，只會專注在操作 todo task data

我們可以直接透過 PostMan 來丟丟看

我們設定必須要使用 API-key 才能存取 API，比較進階的做法就是使用 Oauth 的方式取得 token 來存取 API

不過在這個小 API 也不會建立一個 Oauth Server，我們簡單使用 API-key 來認證即可

接下來的時間我們就會開始依據規劃好的文件，使用 Node.js + express + mongodb 來實作囉!

Back to posts