YAPI自动生成接口文档,解放测试人生产力
ninehua 2025-01-14 16:14 36 浏览
点击上方头像关注我,每周上午 09:00准时推送,每月不定期赠送技术书籍。
本文2149字,阅读约需6分钟
Hi,大家好。我是CoCo。如果接口文档信息不全或是没有接口文档的情况下,领导要求我们做接口自动化测试,这无异是一个非常艰辛的任务。但是编写接口文档的工作量很大,怎么办呢?有什么自动化工具可以协助我们生成文档呢?
众里寻他千百度,最近发现一款工具可以大大解放我们工作,自动生成接口文档,那就是YAPI。今天就给大家介绍YAPI这款工具~
一
YAPI介绍
简介
YAPI是高效、易用、功能强大的API管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YAPI还为用户提供优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
功能特性
主要功能特性如下:
- 可视化接口管理;
- 数据Mock;
- 自动化接口测试;
- 数据导入(各类数据,包括swagger、har、postman、json、命令行等);
- 权限管理;
- 支持本地化部署;
插件
YAPI支持如下的一些插件:
- yapi sso 登录插件;
- yapi cas 登录插件 By wsfe;
- yapi gitlab集成插件;
- oauth2.0登录;
- rap平台数据导入;
- dingding 钉钉机器人推送插件;
- export-docx-data 数据导出docx文档;
- interface-oauth-token 定时自动获取鉴权token的插件;
- import-swagger-customize 导入指定swagger接口;
其中oauth和swagger插件是相当实用的。
二
YAPI使用简介
试用
YAPI试用地址如下:http://yapi.demo.qunar.com/
功能简介
可以支持数据导入,和文档导出,可以把项目中的接口导出到HTML文件,同时在本地word中,就可以将HTML文档转换为word文档,更方便我们转播和存储。
三
YAPI安装使用
如何安装YAPI呢?直接采用Docker安装最为简单(需要有Docker使用基础)。
官方地址:https://github.com/YMFE/yapi/
通过docker安装:https://github.com/Ryan-Miao/docker-yapi
安装Nodejs
访问 node中文网 https://nodejs.org/zh-cn/ ,下载长期支持版,下载后安装即可。
MogoDB安装和配置
访问 http://navo.top/f2YVJz,下载安装文件:
安装时,注意去掉勾选如下,之后一直下一步即可:
安装YAPI
在cmd窗口执行如下命令:
安装完成后执行会启动yapi可视化安装服务yapi server,打开浏览器访问http://localhost:9090
点开“开始部署”,成功后有如下界面,记得记住自己的用户名和密码。
启动YAPI平台
在cmd窗口,进入自己的yapi的安装目录,比如我的安装目录是D:\my-yapi
执行命令node vendors/server/app.js ,启动后在浏览器访问http://localhost:3000
YAPI跨域插件安装
访问http://navo.top/muYr6f 下载yapi跨域插件并安装至chrome浏览器。
项目创建
登录项目,点击新建项目,然后手动添加接口:
添加成功后依次编辑及运行,可以完成接口调试:
一个个的添加接口效率较慢,我们可以采用Fiddler抓包,导出为pinter.har文件,再直接导入yapi平台的方式快速添加接口。
导入har文件
将抓到的请求导出为har文件:
选择导出格式:
然后点击下一步,保存为.har文件在yapi平台中点击【数据管理】,选择数据导入方式为HAR,点击上传pinter.har,然后点击确认。
再次进入yapi平台【接口列表】,两个接口依据顺利导入,进入【测试集合】,导入待测接口。
导入后点击开始测试:
是不是非常方便?赶快搭建属于你们自己的接口管理平台,解锁更多功能!
更多系列文章
敬请期待
ITester软件测试小栈(ID:ITestingA),专注于软件测试技术和宝藏干货分享,每周准时更新原创技术文章,每月不定期赠送技术书籍,愿我们在更高处相逢。喜欢记得星标?我,每周及时获得最新推送,第三方转载请注明出处。
相关推荐
- Photoshop 2024 v25.7.0[ps 2024最新正式版]中文破解版+安装教程
-
Photoshop2024v25.7.0[ps2024最新正式版]中文破解版+安装教程...
- 和基友合体,骑着基友去战斗!暗黑风砍杀刷宝新游!
-
大家好,这里是每周一更新的《图个好游戏》,我是正惊小弟!又到了我们看图挑游戏的日子,废话不多说,上图!...
- 真能复印钞票吗?纸币复印实战与防伪
-
|责编:王征【中关村在线原创】笔者在测试具有彩色复印功能的产品时,无数人都问过同一个问题,能复印钞票吗?复印的假钞和真品,区别在哪里?ZOL就在这里为您揭开复印假钞的面纱。更希望能够通过我们的努力,...
- 可能从今往后,你想下载的所有资源都不用花钱了
-
文/碎长“楼主好人,一生平安”这是十多年前互联网论坛上最常见的几句回复,如果你也曾是那个时代的用户,相信一定可以秒懂我在说什么。资源分享、免费影视、无损音乐、破解游戏......虽然这些东西如今上不了...
- Adobe Photoshop 2024 Beta 25.9【PS Beta测试版】完整破解版
-
AdobePhotoshop2024Beta25.9【PSBeta测试版】完整破解版...
- 电软回忆录:90年代国内游戏已近绝境,全球游戏行业却在蓬勃发展
-
对于游戏玩家们来说,当年听过最心酸的一句话就是:“国内游戏已近绝境,而全球范围的游戏行业却进入蓬勃兴旺的鼎盛时期。”次时代的降临,让全球的玩家都兴奋不已。然而在国内,游戏这都还没来得及壮大,就已经被扼...
- 裸照一键定制软件疯传网络:每个人都会成为受害者
-
蒙娜丽莎被“一键脱衣”。定制一张裸照需要多长时间?最新的技术只需要30秒。你不需要有高超的PS技术,不必有想象力,也不用知道任何数据或细节。只要有一张个人照片,普通的家用电脑就能制造一张原本不存在的裸...
- Photoshop 最新版PS 2024免破解直装安装包下载+PS 2024图文安装教程
-
AdobePhotoshop2024简称PS2024,是一款由AdobeSystems开发和发行的图像处理软件。Photoshop主要处理以像素所构成的数字图像。AdobePhotoshop...
- 正版PS来了!Adobe全球唯一旗舰店登陆天猫,888元/年
-
说起Photoshop或者Adobe全家桶软件,大家都不陌生吧?我们在学习制图、动画、调音、平面、视频编辑、后期、3D等等都离不开它们。不过经常这款软件的用户应该知道,Adobe旗下的正版软件价格都非...
- 相信我,你会爱上这几个网站的
-
哈喽,大家好啊,我是利兄好久没有分享网站了,今天就给大家安利几个网站。这几个网站都比较实用,可以先收藏哦,说不定哪天你就会用上。...
- 不用花钱买游戏了?索尼PS4全系遭破解:PS5也危险了
-
点击右上方“关注”,第一时间获取科技资讯、技能攻略、产品体验,私信我回复“01”,送你一份玩机技能大礼包。---------------------------------...
- PS神技换头术,学会不要干坏事哦,文末附PS CC2018 下载链接
-
换头术运用:让IU和权志龙合照(同理可以实现和马爸爸合影)警告:仅供技术交流,请勿用于非法用途!(本文没有找到较为合适的权志龙素材,表情不够自然,在素材选取上要尽量贴合原图)...
- 最新版本PS CC软件安装教程及破解方法
-
【最新版本PSCC软件安装教程及破解方法】...