基于Koa2，写个脚手架模拟接口服务

ap-cli 前台模拟接口服务脚手架

项目地址

依据接口定义，帮助你快速的完成接口模拟工作。

主要功能：

• [x] 通过json、js、swagger文件模拟接口数据
• [x] 通过正则匹配指定需要mock的文件
• [x] 生成简单markdown接口文档

目录

• 开始
• 使用
  • 通过js方式模拟数据
  • 通过swagger文件模拟数据
  • 通过正则匹配指定要模拟的文件
• CLI用法
• 完整模板及说明

开始

下载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接口文档
json模板格式查看完整模板及说明

使用

1. 通过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

2. 通过swagger文件模拟数据

这种方式主要是通过swagger生成一个xx_new.json文件，而后进行模拟数据

# 运行会生成一个swagger_new.json文件$ ap-cli -s swagger.json# 模拟数据$ ap-cli -m swagger_new.json

3. 通过正则匹配指定要模拟的文件

当前目录下有3个文件a1.json、a2.js、b1.js,你可以通过正则只模拟a1.json和a2.js文件的数据。

$ ap-cli -m all -r /^a/

CLI用法

完整模板及说明

不论是json、js、swagger文件，最终都是转换成下面的格式进行解决。

示例

[  {    "summary": "获取客户信息接口json",    "url": "/api/get/userinfo",    "method": "post",    "parameters": {      "parsing": true,      "child": [        {          "key": "userid",          "type": "string",          "required": true,          "description": "user id"        }      ]    },    "response": {      "body": {        "id": "0001",        "status": "success",        "userinfo": {          "name": "pc",          "age": 18,          "gender": "boy"        }      }    }  }]

主要属性说明

1-1. parameters属性说明

1-1-1. child属性说明

看完了，感兴趣的话，去试试，点个star或者fork下一起写吧，哈哈。