基于Koa2写个脚手架模拟接口服务的方法

2020-06-17 06:37:56易采站长站整理
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"
}
}
}
}
]

主要属性说明

#字段类型说明默认是否必须备注
1summarystring接口概述xxx接口
2urlstring接口地址/api
3methodstringhttp请求方式get
4parameters/接口请求参数可显示为表格(详见下1-1.parameters属性说明)
5response/接口响应数据

1-1. parameters属性说明

#字段类型说明默认是否必须备注
1parsingboolean是否解析false
2childobject []子节点子节点属性(详见1-1-1.child属性说明)

1-1-1. child属性说明

#字段类型说明默认是否必须
1keystring字段名称
2typestring字段类型string
3descriptionstring字段说明
4requiredboolean是否必须false
5childobject []子节点数据