restful-json-api v0.2.3

restful-json-api

介紹

使用express讀取json檔，產生靜態的restful API server

安裝

npm i restful-json-api

使用方式

const run = require('restful-json-api')
run({
  dev: {
    domain: 'http://localhost', //開發環境的domain
    port: 3000, //開發環境的port
  },
  server: {
    fakeFolder: 'api', //json所在的資料夾
    pathPrefix: '/api', //url的前綴字
    port: 3001, //api server的port
  },
})

可讀取的json資料夾範例

資料夾結構範例(詳細參考本專案的api資料夾)

project(專案位置)
├── api(json所在的資料夾)
│   └── delete(http delete method)
│       └── list(resouce)
│           └── fail.json(失敗的回傳)
│           └── req.json(請求)
│           └── success.json(成功的回傳)
│   └── get(http get method)
│   └── patch(http patch method)
│   └── post(http post method)
│   └── put(http put method)

目前具備的功能

• 依據req.json裡面的資料型態做檢查 1.檢查通過回傳success.json 2.不通過回傳fail.json

• 依據req.json裡面的key是否有問號來判斷必填或選填

"id": "" //id欄位為必填

"name?": ""//name欄位為選填

開發方向

1. 增加多個cors domain設定
2. 增加http status code設定