30秒無需編碼完成一個REST API服務

jinggoing發表於2019-02-16
RESTAPI

JSON Server

30秒內無需編碼快速完成一個模擬的REST API服務。

這個服務主要是給那些需要快速的模擬原型後端介面的前端人員使用的

GitHub：https://github.com/typicode/j…

安裝

$ npm install -g json-server

Example

新建一個 db.json 檔案

{
  "posts": [
    { "id": 1, "title": "json-server", "author": "lucy" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

啟動服務

$ json-server --watch db.json

到這一步30秒不到吧，一個完整的rest api 就基本完成了。

ok,現在直接在瀏覽器開啟http://localhost:3000/posts/,你便能看到資料返回

{ "id": 1, "title": "json-server", "author": "lucy" }

需要注意的地方

  • 支援相對應的 GET，POST，PUT，PATCH，DELETE 請求
  • id的值是不可修改的，在使用PUT，PATCH請求時id這個屬性會被忽略，只有POST時且對應的id值還未被使用時才會被接收
  • 請求的body JSON 必須是一個完整的json字串 像這樣:{"name": "lucy"}
  • POST，PUT，PATCH的請求頭設定 Content-Type: application/json

瞭解以上需要注意的地方後就可以像正常的rest api 一樣去呼叫了

  • get posts 列表中的所有資料

  • get posts 列表中 id 為 1 的 資料

  • post 在posts列表中新增一條資料

這裡的id不需要手動賦值，程式會自動遞增。

其它的可以使用postman來測試請求，反正很方便就對了

當然還有其他更強大的功能如分頁，排序，多條件查詢，模糊查詢等等。都可以直接檢視官方文件：https://github.com/typicode/j…

相關文章