Eolink神技之一、基于数据库智能生成API文档

2023-01-18 数据库云数据库 SQL ServerSQLAPIUML

eolink神技之一、基于数据库智能生成api文档

目录

eolink神技之一、基于数据库智能生成api文档

eolink数据库智能api文档解决的问题

演示流程

一、环境准备

1、eolink环境

2、数据库测试环境:

3、创建测试数据库与表

数据库名称

建表语句

插入测试数据

二、测试脚本编写

1、准备测试sql脚本

2、eolink引入mysql

1、打开eolink

2、添加项目

3、操作面板变化

4、添加mysql数据库连接

5、在线连接mysql

6、mysql连接成功

三、添加mysql用例

1、添加用例

2、编辑用例

3、添加数据库用例操作

四、mysql用例测试

1、无参数查询语句测试

查询测试

2、有参查询语句

添加参数【★★★★★】

错误返回

成功测试:

3、增删改语句测试

1、插入语句

2、删除语句

3、修改语句

4、视图测试

五、批量测试与导出api文档

1、批量测试

2、导出api文档

1、返回用例面板

2、等待生成用例脚本

3、下载生成的用例脚本

4、脚本格式

3、导回api脚本

六、总结

体验地址

eolink数据库智能api文档解决的问题

数据库脚本测试,是在我们cmmi3项目管理中比较重要的一个步骤,需要根据业务逻辑进行完整的sql功能测试,其实很多的时候作为dba也是很麻烦的创建一堆的文档来记录,特别是在执行批量脚本的时候麻烦的很,那么,我们可以使用eolink的这个功能来记录、测试、导入导出api,这样对于dba来说就会节约很多的时间以及免掉整个文档处理的麻烦事情。并且可以在移交测试人员的过程中更为顺利。

演示流程

1、环境准备 2、数据库与数据表的准备 3、引入mysql数据库 4、创建测试用例 5、完成crud测试

一、环境准备

这个步骤中我们主要准备eolink的环境以及mysql的环境,mysql的环境我使用的是阿里的数据库,缴费时间还有800多天,这两年测试用我这个数据库就行。免费提供。

演示步骤

1、eolink环境准备 2、数据库测试环境 3、创建测试数据库与表

1、eolink环境

eolink官网地址:eolink-api接口管理平台_api管理系统_接口自动化平台

eolink下载地址(windows端):https://data.eolink.com/winx64/eolink.exe

一键next式的安装,安装完成后建议使用微信登录,很方便。

2、数据库测试环境:

阿里的ecs:mysql数据库5.7.32-log版本

rm-bp1zq3879r28p726lco.mysql.rds.aliyuncs.com

可以直接测试使用。我用于教学的。

username:qwe8403000

pwd:qwe8403000

截止日期到未来的823天,放心测试。 

3、创建测试数据库与表

数据库名称

eolink_test

create datebase eolink_test;

建表语句

create table `eolink_mysql_api` (
`id`  int(8) not null auto_increment comment '编号' ,
`createdate`  datetime not null comment '创建时间' ,
`modifydate`  datetime not null comment '修改时间' ,
`phone`  varchar(20) not null comment '手机号' ,
`username`  varchar(20) not null ,
`pwd`  varchar(200) not null comment '加密方式不定义故而写200' ,
`introduce`  varchar(200) not null comment '简介' ,
primary key (`id`),
unique index `only_phone` (`phone`) using btree 
)
comment='测试eolink的数据表'
;

插入测试数据

insert into eolink_mysql_api values
(0,now(),now(),15633558181,'eolink_admin','123456','专为开发者设计的api协作平台'),
(0,now(),now(),15733558181,'eolink_support_get','123456','eolink_支持_get协议'),
(0,now(),now(),15333558181,'eolink_support_post','123456','eolink_支持_post协议'),
(0,now(),now(),15533558181,'eolink_support_put','123456','eolink_支持_put协议'),
(0,now(),now(),15833558181,'eolink_support_delete','123456','eolink_支持_delete协议'),
(0,now(),now(),15933558181,'eolink_support_mock','123456','eolink_支持_mock'),
(0,now(),now(),15833558182,'eolink_support_mysql','123456','eolink_支持_mysql')
;

创建视图

# 创建视图
create view eolink_view as select * from eolink_mysql_api where introduce like '%p%';
# 查询视图
select * from eolink_view;

二、测试脚本编写

演示步骤

1、准备测试sql脚本 2、eolink引入mysql

1、准备测试sql脚本

增加语句

# 增加语句
insert into eolink_mysql_api values(0,now(),now(),'13472040766','eolink_super_admin','123456','专为开发者设计的api协作平台');

删除语句

# 删除语句
delete from eolink_mysql_api where phone = '13472040766';

修改语句

# 修改语句
update eolink_mysql_api set pwd =password('123456') where username = 'eolink_admin';

查询语句

# 查询语句
select * from eolink_mysql_api where username = 'eolink_admin'; 

视图调用

# 查询视图
select * from eolink_view;

2、eolink引入mysql

演示步骤

1、打开eolink 2、添加项目 3、操作面板变化 4、添加mysql数据库连接 5、在线连接mysql 6、mysql连接成功

1、打开eolink

我这里使用的是eolink客户端,下载完成后进行注册登录。

2、添加项目

点击左上角的【api管理】,选择【api自动化测试】 

页面效果:

选择添加项目

添加一个项目,输入测试名称与备注,点击确定。

进入项目 

3、操作面板变化

我们终于找到数据库连接了。

4、添加mysql数据库连接

在第4步骤中我们看到了数据库连接的选项,我们进行点击,点击之后看到的面板中我们选择【添加数据库连接】

5、在线连接mysql

这个步骤麻烦一些,按照下图逐一操作即可。我都标注顺序了,如果你没有在线的数据库可以使用我的,使用时间绝对保证你能彻底掌握这个操作。

6、mysql连接成功

三、添加mysql用例

演示步骤

1、添加用例 2、编辑用例 3、添加数据库用例操作

1、添加用例

返回【用例】,选择【添加用例】。

输入用例名称,点击确认创建【用例】。 

2、编辑用例

直接点击我们创建好的用例就能进入编辑了。

页面效果:

3、添加数据库用例操作

点击【添加测试步骤】右侧的下拉菜单,选择【添加数据库操作】。

页面效果:

四、mysql用例测试

演示步骤

1、无参数查询语句测试 2、有参查询语句 3、增删改语句测试 4、视图测试

1、无参数查询语句测试

无参的测试是一个基础测试,我们干活的时候基本上都会跑一个无参的测试一下环境。

输入查询返回结果: 

eo.info(db_result["query"][0]["result"]);

编辑完成后点击保存。

查询测试

结果展现,一目了然。 

2、有参查询语句

重复步骤【3.3】添加新的数据库操作,来完成下列有参的测试步骤。

添加参数【★★★★★】

这里得先手动添加【${变量名}】才会出现后面的【请求参数】对话框。一定要注意,我找了好久才测试出来的,老不容易了。就这个地方必须值你的三连。

添加结果验证:

校验代码:

if(db_result["status"]=="success"){
	if(db_result["query"][0]["result"][0]["username"]=="eolink_admin"){
	    eo.info("查询结果的username是eolink_admin所以测试成功");
	}else{
	    eo.stop("返回结果与需求不符");
	}
}
else{
	//执行失败
	eo.stop("数据库语句执行失败");
}

保存后我们去测试: 

错误返回

由于我们没有添加单引号,故而sql语句报错,我们去修改一下。

从下图中我们能看到,通过与未通过的提示。 

成功测试:

修改sql:

select * from eolink_mysql_api where username = '${username}';

测试成功 

3、增删改语句测试

下面我对增删改语句的测试,其对参数的操作多操作几次就会很熟悉了,我在突破这里的时候我就摸索了好一会,您可以看着我的教程直接操作。很节约时间的。

1、插入语句

带变量参数的插入语句

insert into eolink_mysql_api values(0,now(),now(),'${phone}','${username}','${pwd}','${introduce}');

依然在【自定义校验规则】中添加【eo.info(db_result["query"][0]["result"]);】,后面的删除与修改都要添加哦。

保存测试:

2、删除语句

delete from eolink_mysql_api where phone = '${phone}';

测试结果:

3、修改语句

update eolink_mysql_api set pwd =password('${pwd}') where username = '${username}';

测试结果:

4、视图测试

select * from eolink_view;

在结果中可以看到,视图也是可以直接调用的。 

五、批量测试与导出api文档

这里就是我们正式工作中的步骤了,批量测试,查看通过率,都测试通过了代表我们的数据库是可以经得起考验的,是可以提交给下一个部门的时候了。

演示步骤

1、批量测试 2、导出api文档 3、导回api脚本

1、批量测试

点击【批量操作】

勾选所有步骤。

测试结果

2、导出api文档

1、返回用例面板

滚动条拉动到最右侧,选择更多的【导出】功能。

2、等待生成用例脚本

3、下载生成的用例脚本

json类型的

4、脚本格式

脚本为【utf-8】编码格式的【json】数据格式。

3、导回api脚本

我们讲导出的脚本导回到项目中,相当于我们更换设备的时候就更加方便了。

导入过程需要等一会。 

导回成功: 

测试:

六、总结

eolink的这个功能还是非常不错的,相当于对实施工程师和dba都有一定的帮助。特别是实施,很多的时候需要只有一个查询的权限,但是各种老板又各种需求,有了eolink的这个功能就可以根据项目进行划分,为每个企业定制不同的查询需求,并且是在线可用的,相当可以。 主要还得是用在【数据库测试】中,很多时候【dba】会给测试人员一堆【sql】,我们就可以直接使用这个功能,编辑完成后批量测试,刷刷刷就出结果,怎一个痛快了得,值得推荐,非常棒的【神技】。

体验地址

eolink.com

上一篇:将服务器文件上传到GitHub

下一篇:第十四届蓝桥杯集训——JavaC组首篇——环境搭建(win10)