npm 包 eleme-mock-server 使用教程

阅读时长 4 分钟读完

简介

eleme-mock-server 是一个基于 Express 和 Mockjs 的 Web 服务,用于模拟接口数据。eleme-mock-server 在前端开发过程中可以帮助我们更快速、高效地开发,不用等待后端接口开发完成,可以提前预定接口返回数据格式,加快前端开发效率。

此教程将介绍 eleme-mock-server 使用方法,以及如何搭建一个简易的基于 eleme-mock-server 的本地 web 服务。

安装

eleme-mock-server 是通过 npm 安装的,需要先在全局安装 npm:

使用 npm 安装 eleme-mock-server:

这样 eleme-mock-server 就被安装到了你的项目依赖中。

使用

eleme-mock-server 预设了一个 server.js,在本地启动一个 Express 服务,提供 mock 接口。

新建 mock 文件

首先,在项目根目录中新建一个 mock 文件夹,在其中新建一个 api.js 文件,用于编写接口信息。

编写接口

在 api.js 文件中编写你需要模拟的接口,例如:

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

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

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

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

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

上面的例子中,我们定义了两个接口,一个 GET 方式的 /api/data 接口,一个 POST 方式的 /api/login 接口,分别生成了不同格式的返回数据。

此外 eleme-mock-server 还可以支持不同格式的请求参数,例如 path(URL 参数)、query(查询字符串参数) 和 body(POST 请求的请求体参数)。具体使用方法可以参考 GitHub eleme-mock-server README

启动服务

在 package.json 文件中,可以通过 scripts 字段添加启动命令,例如:

上述命令表示在 3000 端口上启动 eleme-mock-server 服务,并提取项目根目录下的 ./mock/api.js 文件作为接口配置文件。

启动命令之后,通过访问如 http://localhost:3000/api/data 可以看到 GET 方式的返回数据;通过 POST 方式的请求,您也可以获取相应的返回值。

总结

以上就是 eleme-mock-server 的基本使用方法,eleme-mock-server 简单易用,可以帮助我们更快速、高效地开发,同时也隐含了开发接口需要高度规范化、接口需求不能临时变更等要求,有利于前端开发与后端接口协作方式的统一。

示例代码:https://github.com/EmmaZhangzy/eleme-mock-server-example

参考

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

纠错
反馈