快速構建 RESTful API的神器:json-server

1.前言導論

現今的前端工程師在進行網頁開發時,常常需要與後端進行協作,而後端提供的 API 介面通常需要在前端網頁中進行測試。這時候,若後端的 API 介面尚未完成或者還在開發中,為了減少後端開發的時間和成本,前端工程師就需要自行模擬後端 API 接口介面來進行開發和測試。而 json-server 就是一個很好用的接口模擬工具。

json-server 是一個運行在 Node.js 環境下的 Express 伺服器,可以通過一個 JSON 文件作為 API 的數據源,快速生成一個 RESTful 風格的後端服務,它可以讓我們快速地搭建一個 RESTful 風格的後端接口,非常適合前端接口測試使用。使用 json-server 可以簡化前端開發人員的工作,讓前端開發人員可以在不依賴後端 API 的情況下進行開發和測試。

本文將介紹一款簡單易用的API模擬工具 —— json-server,幫助前端工程師進行快速測試。

2.原理概念

json-server 基於 Node.js 環境下的 Express 伺服器模擬 API 介面的工具,可以讓我們指定一個 JSON 文件作為接口的資料源,將 API 的資料存放於 json 檔案中。我們只需要在 JSON 文件中寫入數據,json-server 就能夠將其轉換為 RESTful API。

而且 json-server 支援 CRUD(GET、POST、PUT、PATCH、DELETE) 等 HTTP 方法,並且支援分頁、排序等操作,並提供相應的接口給前端使用,甚至可以提供靜態檔案伺服器的功能,透過 json-server 啟動一個網頁伺服器,以此提供 API 的相關功能。

具體的說明可以參考存放在 github 的官方 repository

3.實現步驟

要使用 json-server,首先需要在本機安裝 node.js 環境。接著,在指定的資料夾中建立一個 json 檔案,作為 API 的資料來源。該檔案中需定義相應的資料結構,如:使用者、產品、訂單等。

接著,透過指令啟動 json-server,並指定剛才建立的json檔案作為資料來源。啟動後,即可在本機瀏覽器中透過 API 的 URL 進行 API 操作。

使用 json-server 很簡單,只需要參照下列步驟:

  1. 安裝 Node.js 環境,可從官方下載

4.實作範例

假設我們需要使用 json-server 模擬API介面來實現一個使用者清單的API介面,可先建立一個users.json檔案,並在該檔案中定義使用者資料的格式:

{
  "users": [
    {
      "id": 1,
      "name": "Alice",
      "age": 25
    },
    {
      "id": 2,
      "name": "Bob",
      "age": 30
    },
    {
      "id": 3,
      "name": "Charlie",
      "age": 35
    }
  ]
}

我們可以通過以下接口來訪問這個數據:

  • GET /users:獲取所有用戶列表;
  • GET /users/1:獲取 id 為 1 的用戶信息;
  • POST /users:創建一個新的用戶;
  • PUT /users/1:更新 id 為 1 的用戶信息;
  • DELETE /users/1:刪除 id 為 1 的用戶信息。

5.結論

json-server 是一個非常方便實用的接口模擬工具,它可以讓我們快速地搭建一個 RESTful 風格的後端接口,簡化前端開發流程,提高開發效率。如果您是一個前端工程師,那更需要學會怎麼使用 json-server 來幫助你在開發過程中,避免因為後端開發延遲,而造成你工作進度的延遲。

即使後端工程師因為一些因素改變的資料庫的結構或輸出格式,你也可以快速調整自己 json-server 中的 json 檔來適應後段的變動,而不至於影響你前端這邊的開發進度。

6. 參考文件

Jerous

跨領域跨到劈腿,網站前端的路途,一路向前。前擋設計,後攻工程。

想知道更多嗎?

填入常用的電子郵件,即可在第一時間獲取最新知識!

Subscription Form