基於koa2的前端mock接口服務腳手架

ap-cli

項目地址

依據接口定義，幫助你快速的完成接口模擬工做。

主要功能：

• 經過json、js、swagger文件模擬接口數據
• 經過正則匹配指定須要mock的文件

目錄

• 開始
• 使用
  • 經過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接口文檔

使用

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用法

#	縮寫	完整	默認	說明
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吧，哈哈。