l-mock
说明
一个用命令行解决接口 Mock 的工具，使用简单，支持 XHR, Fetch。
安装
npm i l-mock -g
Quick Start
第一步：
定位到项目目录
cd path/to/project
第二步：
初始化:
lmock init
init命令会在项目根目录下创建默认文件夹 mock，通过--dir参数可指定目录名
第三步：
定位到 mock 目录
cd mock
运行 mock 服务
lmock start
启动参数
--port: 可选，默认监听 3000 端口，可通过--port配置端口，支持多项目同时 mock
--ui: 可选，同时启动 UI 编辑界面
访问localhost:3000/a 成功返回数据
访问localhost:3000/ui 调起 UI 界面
使用说明
| Params | Value | Description |
|---|---|---|
| url | /xx | 请求 api, 支持正则的匹配模式 |
| method | get/post/put/delete | 请求方法 |
| dataType | jsonp | 可选 当请求为 jsonp 时需配置该项，仅当 result 为 JSON 时生效，为 function 时要自己处理返回 |
| contentType | multipart/form-data |
可选 当方法为post且请求类型为multipart/form-data时，需配置该参数 |
| test | http://test/api/1 | 可选 将请求代理到测试地址，当配置 product 时，优先代理 product |
| product | http://prod/api/1 | 可选 将请求代理到正式地址 |
| result | JSON/Function |
JSON 直接配置静态/动态数据，动态数据的配置可参考 Mockjs Function 支持返回一个方法，你可以读取请求参数进行一些判断, 并返回自定义内容，支持 Mock 和文件读取 |
例子
1. 返回 JSON 格式数据
/*
返回简单的json数据，变量语法可参考 http://mockjs.com/examples.html
*/
module.exports = {
url: "/a",
method: "get",
result: {
"status|1": [
"no_login",
"OK",
"error",
"not_registered",
"account_reviewing",
],
msg: "@csentence()",
data: {
a: 2,
},
},
};2. 返回 JSONP 格式数据
/*
返回简单的json数据，变量语法可参考 http://mockjs.com/examples.html
*/
module.exports = {
url: "/a",
method: "get",
dataType: "jsonp",
result: {
"status|1": [
"no_login",
"OK",
"error",
"not_registered",
"account_reviewing",
],
msg: "@csentence()",
data: {
a: 2,
},
},
};3. 自定义函数
/*
用户可以自定义返回函数，采用express语法
当请求方法为post且Content-Type为multipart/form-data，需设置contentType参数
*/
module.exports = {
url: "/b",
method: "post",
contentType: "multipart/form-data",
result: function (req, res) {
// POST方法req.body获取请求信息
if (req.body.name === "admin" && req.body.password === "admin") {
res.send({
msg: "登录成功！",
code: 0,
authorization: "fdjflsjflfds4f5df5s4f5d4f5s",
});
} else {
res.send({ msg: "账号或者密码错误！", code: 1 });
}
},
};4. 支持 Model 数据结构引用
/*
饮用model文件夹中的模型
*/
// model/user.js
module.exports = {
avatar: "@image(100x100)",
nickname: "@cname",
user_type: 1,
vip: 1,
};
// api/d.js
module.exports = {
url: "/d",
method: "get",
result: function (req, res) {
const Mock = res.Mock;
const User = res.require("model/user");
const json = {
status: "ok",
data: {
user: User,
},
};
res.send(Mock.mock(json));
},
};5. 动态 Mock 和文件读取
/*
demo c: url 请求接口支持动态url参数，:id
just-mock 提供了暴露Mock方法和require方法，当数据量大时，用户可以直接引入独立json文件, 或进行Mock操作
*/
module.exports = {
url: "/c/:id",
method: "get",
result: function (req, res) {
const Mock = res.Mock;
const json = res.require("./c.json");
// url 参数通过req.params获取，?xxx=xx参数通过req.query获取
if (req.params.id === "1") {
// res.cookie('name', 'tobi', { domain: '.example.com', path: '/admin', secure: true });
res.send({ msg: "获取用户" + req.params.id + "信息成功" });
} else {
res.send(Mock.mock(json));
}
},
};6. 代理接口
/*
将API接口请求代理到远端服务器接口 http://remote.domain.com，解决远端接口跨域问题
*/
module.exports = {
url: "/e",
method: "post",
test: "http://remote.domain.com",
result: {},
};UI 操作界面
2.0 版本新增 UI 操作界面，支持特性：
- 输入提示；输入
@会自动提示 Mockjs 的变量语法，不用频繁查询 API 文档 - 预览请求结果；保存代码可实时查看接口返回的数据格式
- 支持动态配置请求参数；类似 postman 的功能，便于调试参数或代理接口
项目快速配置
工具也可以只安装在项目中作为开发依赖，不用全局安装
npm i l-mock --save-dev
修改 package.json 中的 scripts
"scripts": {
"mock": "cd mock && lmock start",
}
运行时执行 npm run mock
API 用法
除了用命令行模式开启服务，还可通过与工程脚本配合，用代码启动服务
const path = require("path");
const lmock = require("l-mock");
const mockDir = path.resolve("./mock/");
const port = 4000;
lmock.start(mockDir, port);