npm 包 json-server-master 使用教程

阅读时长 3 分钟读完

介绍

JSON Server 是一个基于 Node.js 的简单 REST API 后台服务,它可以帮助我们快速的构建一个模拟的 REST API 服务器,利用 json 数据文件,轻松的实现产品或项目中的前端数据模型调试。它支持大部分 HTTP 方法,并支持自定义路由和请求间延迟,交互起来非常的方便。

安装

在使用之前,我们需要先通过 npm 来全局安装 json-server-master 包,通过以下命令即可安装:

使用方法

下面我们通过一个实例来学习如何使用 json-server-master。

步骤1:创建数据文件

我们需要先创建一个 .json 数据文件,它可以是一个普通的 JSON 数据格式,也可以是一个模拟的数据文件。比如,我们可以通过在文件夹内新建一个 db.json 数据文件,它的内容如下:

-- -------------------- ---- -------
-
  -------- -
    -
      ----- --
      -------- ----- ------ ----
      --------- ---------
      ------- ----- ------ ----- ------- --- ---- --- ------
      ----------- -
        -
          ----- --
          ---------- --------
        -
      -
    -
  -
-

步骤2:启动服务

启动服务的命令如下:

然后按下回车键就会启动成功,你会看到以下输出:

步骤3:访问数据

我们可以通过以下 API 地址来访问数据:

  • GET /posts: 获取所有的文章数据
  • GET /posts/:id: 获取 id 为指定数值的文章数据
  • POST /posts: 添加一篇新文章
  • PUT /posts/:id: 修改 id 为指定数值的文章数据
  • DELETE /posts/:id: 删除 id 为指定数值的文章数据

比如,我们可以通过以下 API 地址来获取所有的文章数据:

步骤4:使用自定义路由

如果我们需要使用自定义路由,则可以使用 json-server-master 提供的工具,比如:

这样,当访问 /api/xxx 的时候,就相当于访问 db.json 中的 /xxx。类似地,访问 /:resource/:id/show 就够相当于访问 /:resource/:id,以此类推。

步骤5:使用延迟

如果我们需要模拟延迟,可以使用 --delay 参数:

这样,每次访问服务器时,都会有 200 毫秒的延迟。

总结

通过 json-server-master,我们可以方便快捷地进行 REST API 的开发和测试。不仅如此,它还可以与前端框架(如 Vue、React 等)紧密结合,让我们的 Web 开发更加高效和愉悦。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005662a81e8991b448e2033

纠错
反馈