EOLINKER API Studio 5.0.5 版本更新,新增支持自定义 Mock API 功能、支持读取 Java 代码注释生成 API 文档等功能
2019,3,27 更新

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  数据,将会自动转为默认期望,如下图。

5.0.5 版本 MOCK API 界面

2.编辑 Mock API 期望页中可编辑信息为:

a.Mock API 期望名称;

b.请求触发条件(当请求信息中包含以下信息时返回指定内容);

其中“更多设置”包括

c.预期返回数据,可选 Json 编辑器、Raw、Javascript,其中 Json 编辑器模式下支持导入 json 和导入文档的 Json 返回内容;Raw 模式适用于源数据;Javascript 模式支持运行 js,同时支持mockjs 语法

编辑Mock API期望页面

3.存在相同的触发条件时,页面会提示重复。

提示重复

4.新增预览功能,单击预览,会弹窗显示构造出来的 Mock API 数据。

预览数据

之前的MOCK API设置页面

数据报表

1.项目概况页能够查看未编写测试用例的 API 和测试用例数量较少的 API。

1.项目概况页的测试用例覆盖率根据百分比显示不同颜色,并且点击可以查看未编写测试用例的 API;

2.项目概况页的 API 测试用例覆盖系数根据数量显示不同颜色,并且点击可以查看测试用例数量较少的 API:

5.0.5的项目概况页

未编写测试用例的API详情

测试不够完善的API

之前的项目概况页

API文档

1.扫描代码注释生成文档功能,目标语言除了 PHP 外,新增对 Java 的支持。

支持Java语言

2.返回参数加入 JSON、XML、RAW 数据类型,支持 json 和 xml 相互转换。

1.API 文档的返回参数中加入 JSON、XML、RAW 三种数据类型,新的参数默认选择 json 类型。

2.如果原先文档已有数据,数据不设置类型,但再次编辑就会默认选中 json。

3.提供 json 和 xml 相互转换的功能(json 转 xml、xml 转 json),保留原有的导入 json /导入 xml 功能。

5.0.5版本的API文档编辑页中的返回参数

之前的API文档编辑页中的返回参数

3.XML 类型的请求参数和返回参数默认有一个根节点。

由于 XML 结构原因,最外层的参数没有拖动调整顺序的功能,并且类型只有 Object,默认是必填并且无法取消。

5.0.5的请求参数和返回参数的XML编辑页面

之前的请求参数XML编辑页面

4.API 详情页的请求参数类型如果是 json 的话,会显示 Json 的最外层结构是 Object 还是 Array 。

5.0.5版本的API详情页请求参数界面

之前API详情页请求参数界面

5.静态 Mock 内容若超出范围,超出部分会在保存时被自动截断。

自动截断

6.新的 Mock 调用地址规则,mockapi.eolinker.com 将替换原有的 mock.eolinker.com。

Mock 调用地址新的规则为:mockapi.eolinker.com/{project_hash_key}/{api_url},原有的 mock.eolinker.com 支持继续使用一段时间。

新的Mock API调用地址