还在手工写接口测试文档,已经out了

本文介绍了YApi这款能自动生成接口文档的工具,它提供了专业的接口管理服务,支持多人协作、Mock Server、自动化测试和数据导入导出功能,极大地提高了开发和测试效率。通过Docker进行安装,简化了部署流程。
摘要由CSDN通过智能技术生成

接口文档,顾名思义就是对接口说明的文档。好的接口文档包含了对接口URL,参数以及输出内容的说明,我们参照接口文档就能编写出一个个的测试用例。而且接口文档详细的话,测试用例编写起来就会比较简单,不容易遗漏。

如果接口文档信息不全或是没有接口文档的情况下,领导要求我们做接口自动化测试,这无异是一个非常艰辛的任务。但是编写接口文档的工作量很大,怎么办呢?有什么自动化工具可以协助我们生成文档呢?

众里寻他千百度,最近我发现一款工具可以大大解放我们工作,自动生成接口文档。他就是YApi,先上图说明,这是我在YApi中做的接口文档,是不是蛮专业

在这里插入图片描述

YApi介绍

1 YApi 是什么呢

YMFE 是去哪儿网移动架构组(YMFE)简称,是由FE,iOS和Android工程师共同组成的

• Yapi 由 YMFE开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。

• YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求

• 基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率

• Mock Server 易用的 Mock Server,再也不用担心 mock 数据的生成了

• 自动化测试 完善的接口自动化测试,保证数据的正确性

• 数据导入 支持导入 swagger, postman, har 数据格式,方便迁移旧项目

2 试用地址如下

http://yapi.demo.qunar.com/

在这里插入图片描述

3 这是一个Mock接口数据维护例子
在这里插入图片描述

4 更为强大的是,可以支持数据导入,和文档导出,可以把项目中的接口导出到HTML文件,同时在本地word中,就可以将HTML文档转换为word文档,更方便我们转播和存储。
在这里插入图片描述

安装使用

5如何安装呢,直接采用docker安装最为简单(需要有docker使用基础)

5.1 安装mogodb;

docker run -d --name mongo-yapi mongo;

在这里插入图片描述

5.2 拉取yapi

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

5.3、初始化管理员账号和服务

docker run -it --rm

–link mongo-yapi:mongo

–entrypoint npm

–workdir /api/vendors

registry.cn-hangzhou.aliyuncs.com/anoy/yapi

runinstall-server

在这里插入图片描述

5.4、初始化管理员账号和服务

启动YApi服务

docker run -d

–name yapi

–link mongo-yapi:mongo

–workdir /api/vendors

-p 3002:3000

registry.cn-hangzhou.aliyuncs.com/anoy/yapi

server/app.js

5.5、访问http://ip:3002

在这里插入图片描述

6 mock平台不足地方,如果涉及后台业务,比如查询数据库 ,java方向可以采用springmvc 自己定制,这就需要具备测试开发能力了,例如自定义动态返回接口
在这里插入图片描述

作  者:Testfan 极光老师

出  处:微信公众号:自动化软件测试平台

版权说明:欢迎转载,但必须注明出处,并在文章页面明显位置给出文章链接

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值