自學日記

學習程式相關知識及學習法

0%

使用 JSON Server 模擬 Restful API及使用POSTMAN開發API

使用 JSON Server 模擬 Restful API及使用POSTMAN開發API

什麼是JSON Server

“當應用程式的資料需要後端支援,這時候通常會定義 REST API 來取得後端的資料,但是前端/App 開發人員總不能等後端開發人員將 REST API 都實現完成才開始寫程式,現在有了這個開源工具 – JSON Server,可以很快的為前端/App開發人員提供假資料 ,這樣前後端的開發人員就可以同步開發了”-JSON Server:30 秒內不用寫程式建立完整的偽裝的 REST API

如何安裝JSON Server

我們至Json Server Githubj網站下載:JSON Server,有教學如何下載
首先進行全域安裝
npm install -g json-server
安裝完成後,我們可以至要進行的專案根目錄創建db.json,所謂db.json就是全部的json資料,此處先參考網站的範例:

1
2
3
4
5
6
7
8
9
10
11
12
{

"posts": [
{ "id": 1, "title": "json-server", "author": "typicode" }
],

"comments": [
{ "id": 1, "body": "some comment", "postId": 1 }
],

"profile": { "name": "typicode" }
}

再來啟動 Json Server,在terminal輸入:
json-server --watch db.json
會產生:

此時我們的模擬Restful API完成。

什麼是Postman

在API釋出前需要經過測試,而測試的其中一個工具就是”Postman”,可以測試出是否能正常取得資料,取得正確結果。

如何安裝Postman

至postman網站下載app版,Postman Dowland,下載完之後,我們將剛剛上述Json Sever產生的resource,貼至Postman上,步驟如下:

1.在collections按+新增專案
2.針對專案取名
3.複製Json Sever產生的resourcehttp://localhost:3000/posts/
4.send產生結果
5.此處即可以觀察出API是否成功取得
6.另外可以針對商品列表及商品資料進行取名,http://localhost:3000/posts/可以取得多筆資料,http://localhost:3000/posts/1可以取得單一資料,尾數1代表id,id多少即尾數輸入多少。

以上方式即是自己創建假資料Json並利用Postman進行測試。

參考資料:
JSON Server:30 秒內不用寫程式建立完整的偽裝的 REST API
使用 JSON Server 快速模擬 Restful API
用 JSON Server 模擬 RESTful API
Postman 新手教學|使用Postman 開發出你的第一支 API
API 是什麼? RESTful API 又是什麼?