用JSON-server模擬REST API(一) 安裝運行

Sleepy 發(fā)布于2019-08-19 18:36 / 978人閱讀

摘要：曹縣宣布昨日晚間登日成功長江流域首次發(fā)現(xiàn)海豚支持黨中央決定抄寫黨章勢在必行為了方便，再創(chuàng)建一個文件，寫入然后使用到目錄下執(zhí)行命令，如果成功會出現(xiàn)你的電腦中文件夾所在目錄的路徑如果不成功請檢查文件的格式是否正確。

在開發(fā)過程中，前后端不論是否分離，接口多半是滯后于頁面開發(fā)的。所以建立一個REST風(fēng)格的API接口，給前端頁面提供虛擬的數(shù)據(jù)，是非常有必要的。

對比過多種mock工具后，我最終選擇了使用 json server 作為工具，因為它足夠簡單，寫少量數(shù)據(jù)，即可使用。
也因為它足夠強大，支持CORS和JSONP跨域請求，支持GET, POST, PUT, PATCH 和 DELETE 方法，更提供了一系列的查詢方法，如limit，order等。下面我將詳細(xì)介紹 json server 的使用。

安裝

首先你的電腦中需要安裝nodejs，建議使用最新版本。然后全局安裝json server.

  npm install json-server -g

使用linux和macOS的電腦需要加上sudo

  sudo npm install json-server -g

安裝完成后可以用 json-server -h 命令檢查是否安裝成功，成功后會出現(xiàn)

json-server [options] 

選項：
  --config, -c       Path to config file            [默認(rèn)值: "json-server.json"]
  --port, -p         Set port                                     [默認(rèn)值: 3000]
  --host, -H         Set host                                [默認(rèn)值: "0.0.0.0"]
  --watch, -w        Watch file(s)                                        [布爾]
  --routes, -r       Path to routes file
  --static, -s       Set static files directory
  --read-only, --ro  Allow only GET requests                              [布爾]
  --no-cors, --nc    Disable Cross-Origin Resource Sharing                [布爾]
  --no-gzip, --ng    Disable GZIP Content-Encoding                        [布爾]
  --snapshots, -S    Set snapshots directory                       [默認(rèn)值: "."]
  --delay, -d        Add delay to responses (ms)
  --id, -i           Set database id property (e.g. _id)          [默認(rèn)值: "id"]
  --quiet, -q        Suppress log messages from output                    [布爾]
  --help, -h         顯示幫助信息                                         [布爾]
  --version, -v      顯示版本號                                           [布爾]

示例：
  json-server db.json
  json-server file.js
  json-server http://example.com/db.json

https://github.com/typicode/json-server

運行

安裝完成后，可以在任一目錄下建立一個 xxx.json 文件,例如在 mock/ 文件夾下，建立一個 db.json 文件，并寫入以下內(nèi)容，并在 mock/ 文件夾下執(zhí)行 json-server db.json -p 3003 。

{
  "news":[
    {
      "id": 1,
      "title": "曹縣宣布昨日晚間登日成功",
      "date": "2016-08-12",
      "likes": 55,
      "views": 100086
    },
    {
      "id": 2,
      "title": "長江流域首次發(fā)現(xiàn)海豚",
      "date": "2016-08-12",
      "likes": 505,
      "views": 9800
    }
  ],
  "comments":[
    {
      "id": 1,
      "news_id": 1,
      "data": [
        {
          "id": 1,
          "content": "支持黨中央決定"
        },
        {
          "id": 2,
          "content": "抄寫黨章勢在必行！"
        }
      ]
    }
  ]
}

為了方便，再創(chuàng)建一個 package.json 文件，寫入

{
  "scripts": {
    "mock": "json-server db.json --port 3003"
  }
}

然后使用到 /mock 目錄下執(zhí)行 npm run mock 命令，如果成功會出現(xiàn)

> @ mock /你的電腦中mock文件夾所在目錄的路徑/mock
> json-server db.json -p 3003


  {^_^}/ hi!

  Loading db.json
  Done

  Resources
  http://localhost:3003/news
  http://localhost:3003/comments

  Home
  http://localhost:3003

如果不成功請檢查 db.json 文件的格式是否正確。

操作數(shù)據(jù) GET

這個時候訪問 http://localhost:3003/db 可以查看 db.json 文件中所定義的全部數(shù)據(jù)。
使用瀏覽器地址欄，jQuery.get 或 fecth({method: "get"}) 訪問 http://localhost:3003/news ，則可以看到 news 對象下的數(shù)據(jù),以Array格式返回:

[
  {
    "id": 1,
    "title": "曹縣宣布昨日晚間登日成功",
    "date": "2016-08-12",
    "likes": 55,
    "views": 100086
  },
  {
    "id": 2,
    "title": "長江流域首次發(fā)現(xiàn)海豚",
    "date": "2016-08-12",
    "likes": 505,
    "views": 9800
  }
]

POST

以jquery的 $.ajax 方法舉例,以下代碼會實時的向 db.json 中的 news 對象push一條新的數(shù)據(jù)再次用 get 方式訪問 http://localhost:3003/news , 就可以看到它了

$.ajax({
    type: "post",
    url: "http://localhost:3003/news",
    data: {
      "id": 3,
      "title": "我是新加入的新聞",
      "date": "2016-08-12",
      "likes": 0,
      "views": 0
    }
  }
)

PUT

同樣以jquery的 $.ajax 方法舉例,以下代碼會實時的對 db.json 中的 news 對象中 id=1 數(shù)據(jù)進(jìn)行修改

$.ajax({
    type: "put",
    url: "http://localhost:3003/news/1",
    data: {
      "title": "曹縣宣布昨日晚間登日失敗",
      "date": "2016-08-12",
      "likes": 55,
      "views": 100086
    }
  }
)

// 結(jié)果

[
  {
    "id": 1,
    "title": "曹縣宣布昨日晚間登日失敗",
    "date": "2016-08-12",
    "likes": 55,
    "views": 100086
  }
]

PATCH 和 DELETE 使用方式同上，就不做演示了。

參考資料

json-server源碼： json-server
mockjs源碼： mockjs
demo ：示例代碼