EOLINKER API Studio 已于近期发布5.0.5版本,该版本增强了 API 文档和数据报表功能,新增支持自定义 Mock API 功能,支持读取 gitlab 的 Java 代码注释生成 API 文档等。
本篇文章将会介绍 API Studio 5.0.5 新版本中新增和改进功能。
Mock API
1.支持自定义 Mock API
1.Mock API 成为独立功能,不再依赖于 API 文档中填写的返回参数。进入 API 详情页,点击
"新建期望"按钮会弹窗创建 Mock API 的信息,原先已填写的 MOCK 数据,将会自动转为默认期望,如下图。
[caption id="" aLIgn="aLIgncenter" widTH="1663"]
![](https://data.eoLInker.com/TQgihHf537bc6ac828909f1924e07fbb3a850451edc13ba.png)
5.0.5 版本 MOCK API 界面[/caption]
2.编辑 Mock API 期望页中可编辑信息为:
a.Mock API 期望名称;
b.请求触发条件(当请求信息中包含以下信息时返回指定内容);
其中
"更多设置"包括
- 预期返回状态码(默认200)
- 返回延迟(默认0,最大延迟3000ms)
- 预期返回头部
c.预期返回数据,可选
Json 编辑器、Raw、Javascript,其中 Json 编辑器模式下
支持导入 json 和导入文档的 Json 返回内容;Raw 模式适用于
源数据;Javascript 模式
支持运行 js,同时支持mockjs 语法。
[caption id="" aLIgn="aLIgncenter" widTH="1661"]
![](https://data.eoLInker.com/wp8X5m9be563ca8e4a1c82e61d0fb9160a60fbda34a5205.png)
编辑Mock API期望页面[/caption]
3.存在相同的触发条件时,页面会提示重复。
[caption id="" aLIgn="aLIgncenter" widTH="1660"]
![](https://data.eoLInker.com/hbQ74tM052131312a4f5eb007882eb879b9b5831b785d61.png)
提示重复[/caption]
4.新增预览功能,单击预览,会弹窗显示构造出来的 Mock API 数据。
[caption id="" aLIgn="aLIgncenter" widTH="1668"]
![](https://data.eoLInker.com/H8rc1Ppae5aba521e6979a0030085e574de81d4457e84d1.png)
预览数据[/caption]
[caption id="" aLIgn="aLIgnnone" widTH="1664"]
![](https://data.eoLInker.com/DpRS7H1c0608bce076b6aeb2d27588fc04b51dba411a8b7.png)
之前的MOCK API设置页面[/caption]
数据报表
1.项目概况页能够查看未编写测试用例的 API 和测试用例数量较少的 API。
1.项目概况页的测试用例覆盖率根据百分比显示不同颜色,并且点击可以查看未编写测试用例的 API;
- 90%以上:绿色
- 60~90:黄色
- 60以下:红色
2.项目概况页的 API 测试用例覆盖系数根据数量显示不同颜色,并且点击可以查看测试用例数量较少的 API:
- 1个或以上:绿色
- 0.6~1:黄色
- 0~0.6:红色
[caption id="" aLIgn="aLIgncenter" widTH="1664"]
![](https://data.eoLInker.com/ShPp8ZT458a18b2d8646b482cfec69830c8f570a2c1749b.png)
5.0.5的项目概况页[/caption]
[caption id="" aLIgn="aLIgncenter" widTH="1655"]
![](https://data.eoLInker.com/9g98vg587d7e1861da2027e2a0a73bf0e8b02d8c1788903.png)
未编写测试用例的API详情[/caption]
[caption id="" aLIgn="aLIgncenter" widTH="1668"]
![](https://data.eoLInker.com/4l52pUS188209275258af63740a047035c42e8b1abf6609.png)
测试不够完善的API[/caption]
[caption id="" aLIgn="aLIgncenter" widTH="1658"]
![](https://data.eoLInker.com/DmwqPZf86f03b4731686217fbd9b2e51dda282e92616380.png)
之前的项目概况页[/caption]
API文档
1.扫描代码注释生成文档功能,目标语言除了 PHP 外,新增对 Java 的支持。
[caption id="" aLIgn="aLIgncenter" widTH="557"]
![](https://data.eoLInker.com/EgFBViid0ebeb33900058153825dbf8775072cf0300ff26.png)
支持Java语言[/caption]
2.返回参数加入 JSON、XML、RAW 数据类型,支持 json 和 xml 相互转换。
1.API 文档的返回参数中加入 JSON、XML、RAW 三种数据类型,新的参数默认选择 json 类型。
2.如果原先文档已有数据,数据不设置类型,但再次编辑就会默认选中 json。
3.提供 json 和 xml 相互转换的功能(json 转 xml、xml 转 json),保留原有的导入 json /导入 xml 功能。
[caption id="" aLIgn="aLIgncenter" widTH="1660"]
![](https://data.eoLInker.com/37yjUk5a5c16e53ff381886c3c1c264d58349d49563fdbb.png)
5.0.5版本的API文档编辑页中的返回参数[/caption]
[caption id="" aLIgn="aLIgncenter" widTH="1660"]
![](https://data.eoLInker.com/2MfZBpY8d3b11a0ea0d2c06efef6fdf07c86bbb31bf2756.png)
之前的API文档编辑页中的返回参数[/caption]
3.XML 类型的请求参数和返回参数默认有一个根节点。
由于 XML 结构原因,最外层的参数没有拖动调整顺序的功能,并且类型只有 Object,默认是必填并且无法取消。
[caption id="" aLIgn="aLIgncenter" widTH="1660"]
![](https://data.eoLInker.com/6ZbVC362bc8b26212361d235ca7daeb61b7eba282d0dab7.png)
5.0.5的请求参数和返回参数的XML编辑页面[/caption]
[caption id="" aLIgn="aLIgncenter" widTH="1440"]
![](https://data.eoLInker.com/Z42c1mY3fb8a66762ba4449cf2ddf89a22f8235a388c1cf.png)
之前的请求参数XML编辑页面[/caption]
4.API 详情页的请求参数类型如果是 json 的话,会显示 Json 的最外层结构是 Object 还是 Array 。
[caption id="" aLIgn="aLIgncenter" widTH="1602"]
![](https://data.eoLInker.com/UmMiqZfd07374a7bbbc31920e7538c618091bb75af1990f.png)
5.0.5版本的API详情页请求参数界面[/caption]
[caption id="" aLIgn="aLIgncenter" widTH="1432"]
![](https://data.eoLInker.com/ISmn4t64147668e22c23aefda5143ed3567f12284ff9d5d.png)
之前API详情页请求参数界面[/caption]
5.静态 Mock 内容若超出范围,超出部分会在保存时被自动截断。
[caption id="" aLIgn="aLIgncenter" widTH="1605"]
![](https://data.eoLInker.com/8HbrpH6ddd9b8c34fe53e8880622b7c7c1d0286c2709224.png)
自动截断[/caption]
6.新的 Mock 调用地址规则,mockapi.eoLInker.com 将替换原有的 mock.eoLInker.com。
Mock 调用地址新的规则为:
mockapi.eoLInker.com/{project_hash_key}/{api_url},原有的 mock.eoLInker.com 支持继续使用一段时间。
[caption id="" aLIgn="aLIgncenter" widTH="1608"]
![](https://data.eoLInker.com/kuDjfYG763899d68765079b477f319829057f8f99619540.png)
新的Mock API调用地址[/caption]