基於Koa2，寫個腳手架模擬介面服務

Koa.js Swagger · 發表 2018-11-26 19:45:40

摘要： ap-cli 前端模擬介面服務腳手架專案地址依據介面定義，幫助你快速的完成介面模擬工作。主要功能： [x] 通過json、js、swagger檔案模擬介面資料 [x] 通過正則匹配指定需要mock的檔案...

ap-cli 前端模擬介面服務腳手架

PengChen96/ap-cli" target="_blank" rel="nofollow,noindex">專案地址

依據介面定義，幫助你快速的完成介面模擬工作。

主要功能：

[x] 通過json、js、swagger檔案模擬介面資料
[x] 通過正則匹配指定需要mock的檔案
[x] 生成簡單markdown介面文件

開始

下載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模板格式檢視

使用

通過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檔案，最終都是轉換成下面的格式進行處理。

示例

[
{
"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	summary	string	介面概述	xxx介面	否	無
2	url	string	介面地址	/api	是	無
3	method	string	http請求方式	get	是	無
4	parameters	/	介面請求引數	無	否	可顯示為表格（詳見下1-1.parameters屬性說明）
5	response	/	介面響應資料	無	是	無

1-1. parameters屬性說明

#	欄位	型別	說明	預設	是否必須	備註
1	parsing	boolean	是否解析	false	否	無
2	child	object []	子節點	無	否	子節點屬性（詳見1-1-1.child屬性說明）

1-1-1. child屬性說明

#	欄位	型別	說明	預設	是否必須
1	key	string	欄位名稱	-	是
2	type	string	欄位型別	string	是
3	description	string	欄位說明	無	否
4	required	boolean	是否必須	false	否
5	child	object []	子節點資料	無	否

看完了，感興趣的話，去試試，點個star 或fork下一起寫吧，哈哈。