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

众里寻他千百度，最近发现一款工具可以大大解放我们工作，自动生成接口文档，那就是YAPI。今天就给大家介绍YAPI这款工具~

一、YAPI介绍

1、简介

YAPI是高效、易用、功能强大的API管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YAPI还为用户提供优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

2、功能特性

主要功能特性如下：

可视化接口管理；
数据Mock；
自动化接口测试；
数据导入（各类数据，包括swagger、har、postman、json、命令行等）；
权限管理；
支持本地化部署；

3、插件

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使用简介

1、试用

YAPI试用地址如下：http://yapi.demo.qunar.com/

2、功能简介

可以支持数据导入，和文档导出，可以把项目中的接口导出到HTML文件，同时在本地word中，就可以将HTML文档转换为word文档，更方便我们转播和存储。

三、YAPI安装使用

如何安装YAPI呢？直接采用Docker安装最为简单（需要有Docker使用基础）。

官方地址：https://github.com/YMFE/yapi/

通过docker安装：https://github.com/Ryan-Miao/docker-yapi

1、安装Nodejs

访问 node中文网 https://nodejs.org/zh-cn/ ，下载长期支持版，下载后安装即可。

2、MogoDB安装和配置

访问 http://navo.top/f2YVJz，下载安装文件：

安装时，注意去掉勾选如下，之后一直下一步即可：

3、安装YAPI

在cmd窗口执行如下命令：

安装完成后执行会启动yapi可视化安装服务yapi server，打开浏览器访问http://localhost:9090

点开“开始部署”，成功后有如下界面，记得记住自己的用户名和密码。

4、启动YAPI平台

在cmd窗口，进入自己的yapi的安装目录，比如我的安装目录是D:\my-yapi

执行命令node vendors/server/app.js ，启动后在浏览器访问http://localhost:3000

5、YAPI跨域插件安装

访问http://navo.top/muYr6f 下载yapi跨域插件并安装至chrome浏览器。

6、项目创建

登录项目，点击新建项目，然后手动添加接口：

添加成功后依次编辑及运行，可以完成接口调试：

一个个的添加接口效率较慢，我们可以采用Fiddler抓包，导出为pinter.har文件，再直接导入yapi平台的方式快速添加接口。

7、导入har文件

将抓到的请求导出为har文件：

选择导出格式：

然后点击下一步，保存为.har文件在yapi平台中点击【数据管理】，选择数据导入方式为HAR，点击上传pinter.har，然后点击确认。

再次进入yapi平台【接口列表】,两个接口依据顺利导入，进入【测试集合】，导入待测接口。

导入后点击开始测试：

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

最后感谢每一个认真阅读我文章的人，看着粉丝一路的上涨和关注，礼尚往来总是要有的，虽然不是什么很值钱的东西，如果你用得到的话可以直接拿走

这些资料，对于做【软件测试】的朋友来说应该是最全面最完整的备战仓库，这个仓库也陪伴我走过了最艰难的路程，希望也能帮助到你！凡事要趁早，特别是技术行业，一定要提升技术功底。希望对大家有所帮助……

这些都在我的公众号里免费获取

YAPI自动生成接口文档，解放测试人生产力...相关推荐

Django DRF 自动生成接口文档
文章目录 1. 引子 2. 自动生成接口文档 3. 文档描述说明的定义位置 1. 引子前端请求的url由谁来写 url 主要有后台来写,写完给前端: 如果后台查询数据,需要借助查询条件才能查询前端需 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(二)
二.跨域: 回到顶部跨域知识介绍: 点我以前博客跨域解决方法:CORS:跨域资源共享 CORS请求分类(简单请求和非简单请求) 简单请求(simple request):只需要在头信息之中增加一个 ...
Django框架深入了解_05 (Django中的缓存、Django解决跨域流程(非简单请求，简单请求)、自动生成接口文档)(一)
阅读目录一.Django中的缓存: 前戏: Django中的几种缓存方式: Django中的缓存应用: 二.跨域: 跨域知识介绍: CORS请求分类(简单请求和非简单请求) 示例: 三.自动生成接口 ...
Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
idea swagger生成接口文档_Spring Boot（九）Swagger2自动生成接口文档和Mock模拟数据...
一.简介在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一.后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代表什么含义? 问题二 ...
java自动生成接口文档
java自动生成接口文档 maven依赖工具类展示效果首页接口页在平时的开发过程中必定要写接口文档作为程序员最烦的2件事 1.别人让你写接口文档 2.接手别人的项目没有接口文档由此可见 ...
SpringBoot自动生成接口文档
跟大家介绍一个自动生成接口文档的工具包,作者的理念是注释即文档,在写代码的时候写上注释,项目启动后就会生成接口文档,非常方便,省去了Swagger写注解的过程. 仓库地址:https://github ...
DRF 自动生成接口文档
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
自动生成接口文档之JApiDocs教程
JApiDocs教程前言作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档.写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我 ...
Go 项目自动生成接口文档
CSDN 中文章不一定能及时更新,欢迎关注我的博客查看最新版本:许盛的博客背景如何让后端同学愉快地写接口文档,是个老大难问题. 使用 GraphQL 当接口标准,倒是省了接口文档的问题,连前端代码 ...

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

一、YAPI介绍

二、YAPI使用简介

三、YAPI安装使用

YAPI自动生成接口文档，解放测试人生产力...相关推荐

最新文章

热门文章