Peng Chen
Peng Chen

海贼王に俺はなる

Contact me

github github

2019 © Peng Chen

mock接口服务脚手架【ap-cli】

原创 CLI pengchen    2018, November 28

ap-cli npm version Build Status

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

主要功能:

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

目录

开始

下载ap-cli

$ npm install ap-cli -g

生成模板

$ ap-cli init data

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模板格式查看完整模板及说明

使用

通过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的端口

完整模板及说明

不管是json、js、swagger文件,最终都是转换成下面的格式进行处理。

示例
[
  {
    "tags": "tags标签名",
    "summary": "获取用户信息接口json",
    "url": "/api/get/userinfo",
    "method": "post",
    "paramsTable": [
      "| 字段 | 类型 | 是否必须 | 说明 |\n",
      "|------|------|------|------|\n",
      "| id | string | 是 | 无 |\n"
    ],
    "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 summary string 接口概述 xxx接口
2 url string 接口地址 /api
3 method string http请求方式 get
4 paramsTable array 接口请求参数md表格
5 parameters / 接口请求参数 可显示为表格(详见下1-1.parameters属性说明)
6 response / 接口响应数据
7 tags string 接口文档名称
1-1. parameters属性说明
# 字段 类型 说明 默认 是否必须 备注
1 parsing boolean 是否解析 false
2 child object [] 参数

感谢您的阅读