json-server 快速搭建REST API 服務(wù)器

★ 認識json-server 官方文檔參考

json-server 是一個非常流行的開源工具，用于快速搭建一個完整的 REST API 服務(wù)器。它使用 JSON 文件作為數(shù)據(jù)源，通過簡單的配置即可模擬復(fù)雜的服務(wù)器功能，非常適合前端開發(fā)者在沒有后端支持的情況下進行開發(fā)和測試。

★ 主要特性：

• 零編碼：只需一個簡單的 JSON 文件，你就可以創(chuàng)建一個完整的 API，無需編寫任何后端代碼。
• 靈活性：支持 GET, POST, PUT, PATCH 和 DELETE 請求，可以處理各種 RESTful 請求。
• 即時變更：對 JSON 文件的任何修改都會即時反映在 API 返回中，無需重啟服務(wù)器。
• 路由定制：可以通過配置文件自定義路由，模擬各種 API 路徑和行為。
• 中間件支持：可以使用 Express 中間件來增加額外的功能，如添加 headers、靜態(tài)文件服務(wù)等。
• 低系統(tǒng)要求：由于其簡單性，json-server 對系統(tǒng)資源的要求非常低，非常適合快速原型開發(fā)和小型項目。

★ 使用步驟

1-安裝 json-server (需要先安裝node)

npm install -g json-server

2-創(chuàng)建一個 JSON 文件 eg：db.json

{
  "posts": [
    { "id": "1", "title": "a title", "views": 100 },
    { "id": "2", "title": "another title", "views": 200 }
  ],
  "comments": [
    { "id": "1", "text": "a comment about post 1", "postId": "1" },
    { "id": "2", "text": "another comment about post 1", "postId": "1" }
  ],
  "profile": {
    "name": "typicode"
  }
}

???????3-創(chuàng)建一個用于存放靜態(tài)文件的目錄,通常命名為 public 或 static。

4-啟動 json-server

啟動說明：

1. 使用 --static 標志來指定靜態(tài)文件目錄。如果你沒有指定，json-server 默認會查找名為 public 的目錄
2. API 數(shù)據(jù)由 db.json 提供，靜態(tài)文件服務(wù)由 public 目錄提供
3. npx 是一個 npm 包運行器，它允許你運行在本地 node_modules 目錄或遠程倉庫中的命令。使用 npx json-server 啟動的方式不需要你全局安裝 json-server

啟動方式一: 在 Powershell 窗口中運行

json-server --watch [json文件所在路徑] --static ./public

啟動方式二:

???????
npx json-server [json文件所在路徑] --static ./public

???????5-API接口說明

索引頁路由

http://localhost:3000/

API 數(shù)據(jù)資源路由 (支持GET/POST/PATCH/DELETE)

http://localhost:3000/posts
http://localhost:3000/posts/1
http://localhost:3000/comments
http://localhost:3000/comments/1
http://localhost:3000/profile

靜態(tài)文件資源路由

http://localhost:3000/index.html
http://localhost:3000/favicon.ico

到此這篇關(guān)于json-server 如何快速搭建REST API 服務(wù)器的文章就介紹到這了,更多相關(guān)json-server 搭建REST API 服務(wù)器內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論