入门介绍
部署
License

简单示例

如果您需要添加身份验证、验证或任何行为,您可以将 Json Server 作为模块与其它 Express 中间件一起使用,以下是一个简单示例:

    $ npm install json-server --save-dev

您也可以通过 --config json-server.json 来配置Json Server,一个json-server.json配置文件示例如下:

    // server.js
const jsonServer = require('json-server')
const server = jsonServer.create()
const router = jsonServer.router('db.json')
const middlewares = jsonServer.defaults()

server.use(middlewares)
server.use(router)
server.listen(3000, () => {
  console.log('JSON Server is running')
})

启动服务:

    $ node server.js

您提供给 jsonServer.router 函数的路径是相对于您启动 Node 进程的目录的。如果您从另一个目录运行上述代码,最好使用绝对路径:

    const path = require('path')
const router = jsonServer.router(path.join(__dirname, 'db.json'))

对于一个内存数据库,只需将一个对象传递给 jsonServer.router()

要添加自定义选项(例如 foreignKeySuffix ),将一个对象作为第二个参数传递给 jsonServer.router('db.json', { foreignKeySuffix: '_id' })

请注意, jsonServer.router() 也可以在现有的 Express 项目中使用。