"json-server"实战

"json-server"是一个极其方便的创建伪RESTful服务器的工具。
最简单的用法是,创建一个db.json文件:

{
  "posts": [
    { "id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

然后命令行里运行json-server --watch db.json,你就在http://localhost:3000上得到一个RESTful服务器,可以对postscommentsprofile三个资源进行增删改查。
不少教程都讲述了json-server的命令行使用,项目Readme本身也解释得很详细,这里就不再重复。而更多时候我们的服务器可能没有十分严禁地遵循RESTful,或有些接口有特殊要求,这种情况单使用命令行的json-server通常解决不了。幸运的是json-server也提供模块版本(nodejs里使用)-- 这也是本文的目的,讨论如何使用json-server模块来快速创建符合要求的伪服务器。

#1,使用json-server模块创建RESTful服务器

编辑server.js,你甚至不需要额外创建db.json

const jsonServer = require('json-server')

let server = jsonServer.create()
let middlewares = jsonServer.defaults()

// 伪造的数据库数据
let db = {
  users: [
    {username: 'Monica', id: 1},
    {username: 'Ross', id: 2}
  ]
}
// 也可以直接使用json文件,如:jsonServer.router('db.json')
let router = jsonServer.router(db)

// 设置默认的中间件,包括logger, static, cors(支持跨域)和no-cache(无缓存)
server.use(middlewares)

// 使用生成好的RESTful路由
server.use(router)
// 监听3000端口,启动服务器
server.listen(3000, function () {
  console.log('JSON Server is running')
})

运行node server.js;然后可以用curl localhost:3000/users验证一下,应该会得到:

[
  {
    "username": "Monica",
    "id": 1
  },
  {
    "username": "Ross",
    "id": 2
  }
]

#2,添加非RESTful的接口

假设我想添加一个传统的login接口,非RESTful资源,那应该怎么做呢?
json-server实际上是一个express服务器,所以我们可以在开启前添加接口:

server.post('/login', function (req, res) {
  res.jsonp({username: 'Admin', token: '6666'})
})

// 使用其他中间件、开启服务器等
// ...

#3,添加中间件

我们需要对所有接口做一个权限验证,那可以添加一个中间件:

server.use(function (req, res, next) {
  // isAuthorized是你自定义的一个判断请求是否权限合法的方法
  if (isAuthorized(req)) {
    // 记得调用next(),请求才会被继续处理
    next()
  } else {
    res.sendStatus(401)
  }
})

总结

json-server模块其实就是一个加强版的express。配合前者特有的功能及express本身的api,你可以轻松地创建符合你要求的伪服务器来加速你的前端开发。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 222,183评论 6 516
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,850评论 3 399
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 168,766评论 0 361
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,854评论 1 299
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,871评论 6 398
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,457评论 1 311
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,999评论 3 422
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,914评论 0 277
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,465评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,543评论 3 342
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,675评论 1 353
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,354评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,029评论 3 335
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,514评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,616评论 1 274
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 49,091评论 3 378
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,685评论 2 360

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,711评论 18 139
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,859评论 6 342
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,306评论 25 707
  • 先知先觉经营者; 后知后觉跟随者; 不知不觉消费者
    搏生阅读 196评论 0 0