溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

基于Koa2寫個(gè)腳手架模擬接口服務(wù)的方法

發(fā)布時(shí)間:2020-09-03 10:55:29 來源:腳本之家 閱讀:157 作者:FlyingWWS 欄目:web開發(fā)

ap-cli 前端模擬接口服務(wù)腳手架

項(xiàng)目地址

依據(jù)接口定義,幫助你快速的完成接口模擬工作。

主要功能:

  • [x] 通過json、js、swagger文件模擬接口數(shù)據(jù)
  • [x] 通過正則匹配指定需要mock的文件
  • [x] 生成簡(jiǎn)單markdown接口文檔

開始

下載ap-cli

$ npm install ap-cli -g

創(chuàng)建data.json

[
 {
  "url": "/api/get/index",
  "method": "get",
  "response": {
   "name": "pc",
   "status": "success"
  }
 }
]

運(yùn)行

$ ap-cli -m data.json

現(xiàn)在打開 http://localhost:3000/api/get/index ,你會(huì)得到

{ "name": "pc", "status": "success" }

同時(shí)會(huì)在當(dāng)前文件目錄生成一個(gè)簡(jiǎn)單的markdown接口文檔

使用

1、通過js方式模擬數(shù)據(jù)

格式查看

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
};

運(yùn)行

$ ap-cli -m data.js

查看接口

http://localhost:3000/api/get/userList

2、通過swagger文件模擬數(shù)據(jù)

這種方式主要是通過swagger生成一個(gè)xx_new.json文件,然后進(jìn)行模擬數(shù)據(jù)

# 運(yùn)行會(huì)生成一個(gè)swagger_new.json文件
$ ap-cli -s swagger.json
# 模擬數(shù)據(jù)
$ ap-cli -m swagger_new.json

通過正則匹配指定要模擬的文件

當(dāng)前目錄下有3個(gè)文件a1.json、a2.js、b1.js,你可以通過正則只模擬a1.json和a2.js文件的數(shù)據(jù)。

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

CLI用法

# 縮寫 完整 默認(rèn) 說明
1 -m --mock [fileName] 'all' 模擬接口服務(wù),[fileName]當(dāng)前目錄下要mock的文件名,[all]默認(rèn)當(dāng)前目錄下的所有文件
2 -r --regexp [regexp] 無(wú) 通過正則匹配需要mock的文件
3 -s --swagger [fileName] 無(wú) 通過swagger生成json模板文件,[fileName]當(dāng)前目錄下的swagger文件名
4 -p --port [port] 3000 指定mock的端口

完整模板及說明

不管是json、js、swagger文件,最終都是轉(zhuǎn)換成下面的格式進(jìn)行處理。

示例

[
 {
  "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"
    }
   }
  }
 }
]

主要屬性說明

# 字段 類型 說明 默認(rèn) 是否必須 備注
1 summary string 接口概述 xxx接口 無(wú)
2 url string 接口地址 /api 無(wú)
3 method string http請(qǐng)求方式 get 無(wú)
4 parameters / 接口請(qǐng)求參數(shù) 無(wú) 可顯示為表格(詳見下1-1.parameters屬性說明)
5 response / 接口響應(yīng)數(shù)據(jù) 無(wú) 無(wú)

1-1. parameters屬性說明

# 字段 類型 說明 默認(rèn) 是否必須 備注
1 parsing boolean 是否解析 false 無(wú)
2 child object [] 子節(jié)點(diǎn) 無(wú) 子節(jié)點(diǎn)屬性(詳見1-1-1.child屬性說明)

1-1-1. child屬性說明

# 字段 類型 說明 默認(rèn) 是否必須
1 key string 字段名稱 -
2 type string 字段類型 string
3 description string 字段說明 無(wú)
4 required boolean 是否必須 false
5 child object [] 子節(jié)點(diǎn)數(shù)據(jù) 無(wú)

以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持億速云。

向AI問一下細(xì)節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI