YAPI自动生成接口文档，解放测试人生产力

点击上方头像关注我，每周上午 09:00准时推送，每月不定期赠送技术书籍。

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

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平台【接口列表】,两个接口依据顺利导入，进入【测试集合】，导入待测接口。

导入后点击开始测试：

是不是非常方便？赶快搭建属于你们自己的接口管理平台，解锁更多功能！

更多系列文章

敬请期待

---