快速提示：使用JSON服務器模擬REST API

無需後端即可快速原型設計前端應用？創建即使是最基本的模擬API也可能耗時費力。 json-server庫通過提供一種快速簡便的方法來創建用於開發和測試的複雜RESTful API，從而解決了這個問題。

本快速提示將教您如何使用json-server創建模擬REST API，讓您在短短30秒內即可啟動並運行功能齊全的API。

關鍵要點

• json-server庫可用於快速創建用於開發和測試的複雜RESTful API，允許開發人員在沒有後端的情況下原型設計應用程序的前端。
• json-server提供過濾器、邏輯運算符、分頁和排序等功能，有助於創建可用於測試具有大量偽造數據的前端的模擬API。
• 通過faker.js模塊，開發人員可以為API生成模擬數據，這使得開發和測試過程更高效、更貼近實際情況。

前提條件

您應該具備RESTful原則以及如何使用API的基本知識。

您需要以下工具：

• nodejs – json-server基於nodejs構建。
• curl – 用於測試模擬服務器的路由。

Windows用戶：curl下載頁面提供了32位和64位版本的curl二進製文件，您可以使用它們來學習本文中的示例。

本教程假設您將使用類似bash的終端。

安裝

要安裝json-server，請打開您的終端並輸入：

$ npm install -g json-server

這將在您的系統上全局安裝json-server，以便您可以從任何喜歡的目錄啟動服務器。

資源

在RESTful API中，資源是一個具有類型、關聯數據、與其他資源的關係以及對其進行操作的一組方法的對象。例如，如果您正在為電影創建API，那麼電影就是一個資源。您可以使用您的API對該資源應用CRUD操作。

讓我們創建一個具有/movies資源的API。

創建資源

創建一個名為db.json的文件，並將以下內容添加到其中：

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

保存文件後，使用以下命令啟動服務器：

$ json-server --watch db.json

就是這樣！現在您擁有了一個電影API；您可以從此服務器獲取電影、添加新電影、刪除電影以及許多其他操作。

為了測試我們的模擬API，我們可以使用curl發出HTTP請求：

$ curl -X GET "http://localhost:3000/movies"

這將返回您在此服務器上擁有的所有電影的列表。在上述情況下，您將獲得兩部電影。現在要獲取id為1的電影，只需在URI的末尾指定id：http://localhost:3000/movies/1。

要向服務器添加電影，您可以向API發送包含電影詳細信息的POST請求。例如：

$ npm install -g json-server

這將返回新的電影數據。要檢查記錄是否已成功添加，讓我們嘗試獲取id為3的電影：

{
  "movies": [
    {"id": 1, "name": "The Godfather", "director":"Francis Ford Coppola", "rating": 9.1},
    {"id": 2, "name": "Casablanca", "director": "Michael Curtiz", "rating": 8.8}
  ]
}

同樣，您可以使用其他HTTP動詞（如PUT和DELETE）來訪問和修改此服務器上的數據。按照慣例，POST用於創建新實體，而PUT用於更新現有實體。

注意：PUT、POST和PATCH請求需要設置Content-Type: application/json標頭。

功能

json-server為模擬API提供了許多有用的功能，這些功能您需要在後端手動構建。讓我們探索其中一些功能：

過濾器

您可以通過將過濾器附加到URI作為查詢字符串來應用過濾器。例如，如果您想獲取名為“Casablanca”的電影的詳細信息，您可以向資源URI發送GET請求，附加一個問號（?），然後是您要過濾的屬性名稱及其值：

$ json-server --watch db.json

您還可以通過在不同的過濾器之間添加一個與號（&）來組合多個過濾器。例如，如果我們還想在上面的例子中按id進行過濾，我們可以使用：

$ curl -X GET "http://localhost:3000/movies"

運算符

API還為您提供了邏輯運算符，使過濾更容易。您可以使用_gte和_lte作為大於和小於運算符。您還有_ne用於從響應中排除值。

例如，如果您想要所有評分大於或等於9的電影：

$ curl -X POST -H "Content-Type: application/json" -d '{
  "id": 3,
  "name": "Inception",
  "director": "Christopher Nolan",
  "rating": 9.0
}' "http://localhost:3000/movies"

請注意，您可以使用與號組合多個運算符。因此，要獲取所有評分在5到7之間的電影，您將發出以下請求：

$ curl -X GET "http://localhost:3000/movies/3"

分頁

在現實世界中，您將處理大量數據。使用json-server內置的分頁支持（每頁固定10個項目）可以輕鬆地將這些數據加載到小塊中。

例如，如果您想訪問電影API的第3頁，請發送GET請求：

$ curl -X GET "http://localhost:3000/movies?name=Casablanca"

這將返回第21-30個項目。

排序

您可以使用_sort和_order屬性從API請求排序後的數據。例如，如果您希望電影列表按名稱（按字母順序）以降序排序，那麼您將發送以下請求：

$ curl -X GET "http://localhost:3000/movies?name=Casablanca&id=2"

json-server提供了許多其他功能。您可以在json-server文檔中詳細了解這些功能和上述功能。

為您的API生成模擬數據

使用API中幾乎沒有數據來測試前端是沒有樂趣的。您可以使用像faker.js這樣的模塊為您的模擬API創建一些示例數據。

使用以下命令安裝軟件包：

$ curl -X GET "http://localhost:3000/movies?rating_gte=9"

現在創建一個名為fake-data-generator.js的文件，並在其中輸入以下內容：

$ curl -X GET "http://localhost:3000/movies?rating_gte=5&rating_lte=7"

在這裡，我們創建了1000個不同的假電影條目，使用faker生成電影標題和導演姓名。評分是通過生成1到100之間的隨機數並除以10來創建的。

要使用此腳本創建db.json文件，請在終端中運行以下命令：

$ npm install -g json-server

現在您擁有一個包含1000部電影的數據庫。您現在擁有大量可以用來開發和/或測試您的應用程序的偽造數據。

結論

您現在應該能夠快速創建您自己的模擬API並向其中添加測試數據。 json-server庫允許您快速原型設計前端代碼，而無需花費任何時間（幾乎）來創建前端。

這個工具會成為您工作流程的一部分嗎？或者您還有其他成功使用的方法嗎？請在下面的評論中分享您的想法和建議！

關於使用JSON Server模擬REST API的常見問題解答（FAQ）

使用JSON Server模擬REST API的主要優勢是什麼？

JSON Server提供了一種簡單快捷的方法來為開發和測試目的設置偽造的REST API。它允許開發人員在幾分鐘內創建一個具有CRUD（創建、讀取、更新、刪除）操作的完整REST API。這可以大大加快開發過程，因為它消除了等待後端團隊開發實際API的需要。此外，JSON Server使用JSON文件存儲數據，從而易於修改API的數據和結構。

如何安裝JSON Server？

JSON Server是一個Node.js模塊，因此您需要在系統上安裝Node.js和npm（Node Package Manager）。安裝Node.js和npm後，您可以使用終端或命令提示符中的以下命令在系統上全局安裝JSON Server：npm install -g json-server。

如何使用JSON Server創建模擬API？

要使用JSON Server創建模擬API，您首先需要創建一個JSON文件，該文件將充當您的數據庫。此文件應包含您希望通過API提供的數

(由於篇幅限制，後續FAQ內容將被省略。 如有需要，請提出具體問題。)

以上是快速提示：使用JSON服務器模擬REST API的詳細內容。更多資訊請關注PHP中文網其他相關文章！