关于api:Apikit-自学日记添加及调用-Mock-API

增加及调用 Mock API

在瀑布流开发模式中，如果前端开发人员须要进行页面对接，须要后端先实现 API 的开发工作，因而前后端开发的进度会相互影响。

通过 Mock API，您能够当时编写好 API 的数据生成规定，由 API 研发治理平台 动静生成 API 的返回数据。开发人员通过拜访 Mock API 来取得页面所须要的数据，实现对接工作。

Apikit 提供市面最强的 Mock API 能力体系：

如果用户仅须要疾速的基于接口文档中的返回后果获取对应的随机数据，则能够通过繁难 Mock 性能获取对应信息。

如果用户冀望通过一个 url 模仿不同的申请信息时，获取对应个的返回后果模仿数据，则举荐应用高级 Mock 性能。

一、高级 Mock

性能入口：API 治理利用 / 选中某个我的项目 / API 文档菜单 / 选中某一 API 文档 / 点击“高级 Mock”TAB

高级 Mock API 反对依据不同的申请参数返回不同的 HTTP Status Code、Header、Body 等数据。您能够在一个 API 文档里创立多个高级 Mock API，模仿前端发动的各种申请，不便对前端逻辑进行校验。

当我的项目正式公布时，只需将高级 Mock API 的地址前缀替换为理论的拜访地址即可。

因为同一个我的项目中的高级 Mock API 的地址前缀是雷同的（如 mock.eolinker.com/uasyd1/…），因而能够在代码中将高级 Mock API 的地址前缀作为全局变量，我的项目上线时仅需替换变量的值即可扭转整个我的项目的 API 申请地址前缀。

1.1 增加高级 Mock

在“高级 Mock”页下，点击“增加 Mock”，即会有增加 Mock 信息弹窗。

除了高级 Mock 冀望名称外，其余需输出的信息分成两个局部：申请触发条件和响应内容

1.1.1 申请触发条件

调用高级 Mock 的接口地址时，仅有申请信息满足申请触发条件方会返回该高级 Mock 设置的返回参数。

申请触发条件可设置申请头部、申请体、Query 参数。

申请头部 & Query 参数

• 申请触发条件的信息默认同步文档中的申请参数对应的参数信息。其中申请头部和 Query 参数设置较为简单，间接填写参数和预期参数值即可。
  申请体
• 申请触发条件的申请体数据默认填入文档中的申请体参数信息。

若申请体内有参数，则零碎需校验参数名、字段类型和冀望参数值。其中若 API 文档中有设置参数的示例值，则会主动填入到冀望参数值内。冀望参数值不可为空，若不心愿把该申请参数作为触发条件，则可删除该参数。

冀望参数值校验可选多种运算形式，蕴含正则匹配、等于、不等于、大于、小于、大于等于、小于等于。

申请体触发条件提供是否校验数组内元素的勾选项，默认不勾选。不勾选时，对于数组类型参数仅校验第一个元素是否满足规定。勾选后，会对数组类型参数的所有元素进行校验。

1.1.2 响应内容 -Body

响应内容为满足该高级 Mock 触发条件后，Mock URL 返回的模仿参数值。其中 Eolink 提供以下五种配置响应内容中的响应体的形式

1.1.2.1 追随 API 文档

实时同步 API 文档的返回参数为该高级 Mock 的返回模仿值。即 API 文档调整了返回参数字段或构造后，零碎主动同步对应的构造和模仿值。

追随 API 文档时，各参数输入的模仿值和文档中该返回参数的示例值字段和 Mock 字段相干。

若设置了 Mock 字段，未设置示例字段，则依据 Mock 字段的规定返回动静模仿值；

若未设置 Mock 字段，未设置示例字段，则依据示例字段的内容返回动态模仿值；

若设置了 Mock 字段，且也设置了示例字段，则依据示例字段的内容返回动态模仿值。

即示例字段的优先级高于 Mock 字段。

若未设置 Mock 字段，且未设置示例字段，则输入零碎默认兜底规定：

1.1.2.2 JSON

响应内容应用 JSON 格局编辑时，反对 Mockjs 语法。

在 JSON 的响应内容表格中四个输出字段的解析如下：

仅返回固定值

若用户仅须要返回某个固定值，则仅需把该固定值填入到参数值字段中即可

仅应用 Mockjs 占位符

若用户仅须要应用 Mockjs 占位符即可实现随机数生成，则仅需把 Mockjs 占位符填入到参数值字段中即可。留神需带有占位符前缀 @

反复 Mockjs 占位符输入内容
若用户须要反复 Mockjs 占位符输入的内容，例如占位符为 @mock=”★”，若不填写生成规定字段，则零碎会主动输入一个★。
若生成规定填写 2，则代表须要反复输入 2 次该占位符后果，最终输入★★。
若生成规定填写 1 -3，则代表须要反复输入 1 次到 3 次范畴内随机次数的该占位符后果，最终输入有可能为★或★★或★★★。

字段类型为数字相干类型的非凡用法

若字段类型抉择了 int、float、double、number，当参数值未输出任何内容时。可通过生成规定输入非凡范畴的随机数字。填写规定为：1-1000 代表 1 到 1000 中随机一个数字；若有小数点，小数点后填写 1 -3，则代表小数点后随机呈现 1 到 3 位的数字。

例如 1-10.1-10，则代表小数点前从 1 到 10 随机呈现一个数字，小数点后呈现 1 到 10 位随机数字。所以可能的输入值为 5.2341。

JSON 格局还提供根数据生成规定，需抉择根类型为数组 Aarray 时才会失效，用于配置生成多少个数组元素。

1.1.2.3 XML
应用 XML 格局时，能够编辑 XML 申明，并编辑各参数字段的属性。

1.1.2.4 Raw
当您不须要随机生成数据时，能够抉择 Raw 类型并可填写任意格局静态数据。

1.1.2.5 JavaScript

当您心愿通过代码生成返回数据时，能够应用编写 Javascript 代码的形式，并应用 return 语句返回数据。Javascript 模式中也反对 Mock JS，通过 Mock.mock() 形式调用，详情能够查阅 Mock JS 官网文档。

以下例子示意应用 Javascript 代码联合 Mock JS 生成 随机中文名 + 以后日期 的返回后果：

var date = new Date();
var seperator1 = "-";
var year = date.getFullYear();
var month = date.getMonth() + 1;
var strDate = date.getDate();

// 在这里应用 Mock JS 获取随机中文名
var userName = Mock.mock("@cname");

if (month >= 1 && month <= 9) 
{month = "0" + month;}

if (strDate >= 0 && strDate <= 9) 
{strDate = "0" + strDate;}

var currentdate = year + seperator1 + month + seperator1 + strDate;

return userName+seperator1+currentdate;

1.1.3 响应内容 -Header
响应头部内容会主动同步 API 文档中的返回头部内容，其高级 Mock 的配置也较为简单，间接编辑参数名与参数值即可。

1.1.3.1 响应内容 - 高级设置
用户还能够在高级 Mock 中对响应进行高级设置：配置响应状态码或响应延迟时间。

响应状态码

• 仅 HTTP 协定的高级 Mock 方可配置，可输出 3 位规范的 HTTP 状态码。零碎默认填写 200。

响应延迟时间

• 可配置高级 Mock 的 URL 调用后提早多少秒返回信息。可配置单位为毫秒 ms。

1.2 调用高级 Mock

用户点击高级 Mock 列表页顶部的调用地址，即可复制地址。可把地址黏贴到 IDE 工具中，调用接口进行调试。

1.2.1 调用优先级
一个 API 文档中无论设置了多少条高级 Mock，均仅有一个高级 Mock 调用地址。用户在调用时，依据申请的内容判断触发了哪一条的高级 Mock 设置，并返回对应高级 Mock 的返回后果。

零碎默认提供一条零碎默认冀望的高级 Mock 设置，该配置无任何申请触发条件，代表任何条件均可触发该高级 Mock。但零碎会遵循自定义高级 Mock 设置大于零碎默认冀望设置的优先级，优先执行其余高级 Mock 设置。若其余高级 Mock 设置未被触发时，才会触发零碎默认冀望。

另外，若用户停用零碎默认冀望的高级 Mock，并调用时未有任何其余高级 Mock 被触发，则零碎会返回揭示：无奈找到该 Mock API，并查看相干设置。

1.2.2 启用 / 停用高级 Mock

在保留高级 Mock 配置时，零碎会主动判断其申请触发条件是否和其余高级 Mock 配置雷同。若有雷同的申请触发条件，则会揭示持续编辑以便把申请触发条件批改成不一样的条件，或持续保留以后的高级 Mock 配置，并停用与其申请触发条件雷同的高级 Mock。

用户能够在高级 Mock 列表右侧的操作按钮中，设置启用或停用对应高级 Mock。停用后，即便申请触发条件满足该高级 Mock 的需要，也不会返回该高级 Mock 的返回后果。

二、繁难 Mock

性能入口：API 治理利用 / 选中某个我的项目 / API 文档菜单 / 选中某一 API 文档 / 点击“编辑”TAB

繁难 Mock 性能可在编写 API 文档的时候，同时对不同的返回后果进行 Mock 配置。并且可预置智能 Mock 规定，在编写返回参数时，若参数名和字段类型匹配智能 Mock 规定时，零碎主动填入该参数的 Mock 规定。

配置繁难 Mock 后，API 文档会主动生成 Mock URL，用户可复制该 URL 间接调用得出想要的数据后果。
该性能仅反对 HTTP 协定接口下的 JSON 或 XML 数据类型的返回后果

2.1 增加繁难 Mock

1、进入 API 文档编辑页，选中须要编辑的返回后果
2、数据类型抉择 JSON 或 XML，在参数列表中填写字段名和抉择数据类型，若字段名和数据类型命中了智能 Mock 的规定，则字段名输入框失去焦点后，零碎会主动填充该字段的 Mock 值。

若 mock 值已有内容，则变更字段名或数据类型均不会触发智能 Mock

3、无论是否命中智能 Mock 规定，均可点击 mock 输入框，填写所需的 mock 规定。mock 输入框反对填写数值和 mockjs 占位符。

• 若填写数值，则调用繁难 Mock 的时候固定返回该数值
• 若填写 mockjs 占位符，零碎会依据占位符的输出内容实时展现您可能想输出的值。您点击下拉选项中的可能值后，该值会疾速填入 mock 输入框中。

4、点击保留 API 文档，所增加的繁难 Mock 即可被调用。

2.2 调用繁难 Mock

1、进入 API 文档展现页，下拉至返回参数模块，对应的返回后果题目下，会有繁难 Mock 链接

2、点击 繁难 Mock 链接右侧的复制按钮即可复制到剪贴板，在代码中间接对该地址发动申请即可失去对应后果的虚构数据。

2.3 删除繁难 Mock

进入 API 文档编辑页，在对应的返回后果中，清空对应字段的 mock 值后，调用该繁难 Mock 时，对应字段返回零碎默认的随机数据。