"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服务器,可以对posts
、comments
、profile
三个资源进行增删改查。
不少教程都讲述了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,你可以轻松地创建符合你要求的伪服务器来加速你的前端开发。