ap-cli
项目地址
依据接口定义,帮助你快速的完成接口模拟工作。
主要功能:
- 通过json、js、swagger文件模拟接口数据
- 通过正则匹配指定需要mock的文件
目录
开始
下载ap-cli
$ npm install ap-cli -g
创建data.json
[
{
"url": "/api/get/index",
"method": "get",
"response": {
"name": "pc",
"status": "success"
}
}
]
运行
$ ap-cli -m data.json
现在打开http://localhost:3000/api/get/index ,你会得到
{ "name": "pc", "status": "success" }
同时会在当前文件目录生成一个简单的markdown接口文档
使用
-
通过js方式模拟数据
data.js
const getUserList = () => {
const data = {
"summary": "获取用户列表(get方式)",
"url": "/api/get/userList",
"method": "get",
"parameters": "",
"response": {
"count": 100,
"userList": []
}
}
for (let i = 0; i < 100; i++) {
data.response.userList.push({ id: i, name: `user${i}` })
}
return data
};
module.exports = {
getUserList
};
运行
$ ap-cli -m data.js
查看接口
http://localhost:3000/api/get/userList
-
通过swagger文件模拟数据
这种方式主要是通过swagger生成一个xx_new.json文件,然后进行模拟数据
# 运行会生成一个swagger_new.json文件
$ ap-cli -s swagger.json
# 模拟数据
$ ap-cli -m swagger_new.json
-
通过正则匹配指定要模拟的文件
当前目录下有3个文件a1.json、a2.js、b1.js,你可以通过正则只模拟a1.json和a2.js文件的数据。
$ ap-cli -m all -r /^a/
CLI用法
# | 缩写 | 完整 | 默认 | 说明 |
---|---|---|---|---|
1 | -m | --mock [fileName] | 'all' | 模拟接口服务,[fileName]当前目录下要mock的文件名,[all]默认当前目录下的所有文件 |
2 | -r | --regexp [regexp] | 无 | 通过正则匹配需要mock的文件 |
3 | -s | --swagger [fileName] | 无 | 通过swagger生成json模板文件,[fileName]当前目录下的swagger文件名 |
4 | -p | --port [port] | 3000 | 指定mock的端口 |
感谢您的阅读,点个star吧,哈哈。