APIKnight - Build a mock service

背景

字节青训营的大项目

Mock Service

mock服务：

关于响应参数结构填写

参数属性包括：参数名（key）,参数类型，是否必填，备注，示例值（example）。
基本参数类型有：string,number,boolean,object,array。
如若参数类型选择对象或者对象数组（array[object]），则可以再选择子一级参数。
暂不支持嵌套数组，若选择数组，那么数组里每个值类型都应该一样。

response= {
  example: Object,
  params: Array[Param]
}

Param = {
  key: String,            // 参数名
  type: String,           // 参数类型，string|number|boolean|object|array
  comment: String,        // 备注
  example: String,        // 参数示例值
  items: {                // 当参数类型为array时，此字段生效
    type: String          // 数组的参数类型
    params: Array[Param]  // 当数组参数类型为object类型时，此字段生效，意义为数组内对象的参数模型
  }
}

关于Mock

mock规则

结合了Mock.js，拥有了mock随机假数据的能力。

如若设置了Response的Example，则会返回Example的值，如果当中写了Mock.js的语法，则会生成对应的数据。例如

// example值为：
{
  "status|1-2": true,
  "number|1-100": 100
}
// 则会生成
{
  "status": false,
  "number": 40
}
// 或
{
  "status": true,
  "number": 99
}
// 或其他随机值

如果没有设置Response的Example，则会根据对应params产生mock数据。

生成mock数据时，会优先使用params参数的示例值。
若示例值未填写，则String类型参数mock数据为"value"，Boolean与Number会随机

{
    params:[
        {
            key:id,
            type: string,
            example: "abc123"
        },
        {
           key:name,
           type:string
        }
     ]
}

生成：
    {
        "id": "abc124",
        "name": "value"
    }

背景

相关文档整理

Mock Service