json-server 快速搭建REST API 伺服器

json-server 快速搭建REST API 伺服器

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

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

★ 主要特性

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

★ 使用步驟

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

  npm install -g json-server
  

• 2-創建一個 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-創建一個用於存放靜態文件的目錄,通常命名為 public 或 static。

• 4-啟動 json-server

  • 啟動說明：

    1. 使用 --static 標誌來指定靜態文件目錄。如果你沒有指定，json-server 預設會查找名為 public 的目錄
    2. API 數據由 db.json 提供，靜態文件服務由 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 數據資源路由 (支持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
    

  • 靜態文件資源路由

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