YAPI官方提供了详细的手册，但是对于没集成测试基础的人来说并不是很友好，所以自己一边搭建一边摸索出一个对初学者比较友好的使用手册。

1 登陆

2 项目创建

3 接口创建

4 Swagger的导入

5 测试集合

6 成员管理

7 变更通知

8 项目文档

1 登陆

YAPI提供独立用户库、LDAP、oauth2等多种登陆方式，我推荐的方式是LDAP。

2 项目创建

新建项目前一定要先添加分组，因为这个会涉及到后期的成员权限管理，将项目组的组长设置为自己或者项目负责人。如果使用默认的个人空间，那你的项目永远不会被别人看到，就失去了YAPI的意义。

新建项目时需要选中所属的项目组，项目组内的成员才有对应的权限使用项目中的接口。

3 接口创建

进入项目内，左边导航可以看到接口列表，可以根据实际情况对接口进行分类，也可以只使用默认的“公共接口”分类“。添加接口时需要选择所属分类和请求方式。

配置接口的Reqeust和Response，支持多种形式，除开mock固定返回值，yapi还为我们提供了丰富的mock变量

例如@name:返回随机的人名，@id返回随机的id，@string返回随机的字符串，@ip返回随机IP，@time返回随机时间，yapi提供了上百种mock参数。

运行时可以定制不同的环境，推荐将mock地址设置为，也可以指向预发布或测试环境。

如果想根据不同的传参返回不同的结果，可以在高级mock中添加期望。

4 Swagger的导入

Yapi提供了多种现有接口的导入方式，这里只介绍如何对接swagger。

该段落需要一定研发基础，非研发人员或者未使用swagger管理接口的项目可以跳过该章节。

url请求：

swagger地址：http://ip:port/swagger-ui.html

swagger的Json文件：http://ip:port/v2/api-docs

将swagger的Json文件保存为文件，然后在yapi工具导入:

请注意导入模式的区别：

普通模式：不导入已存在的接口

智能合并：已存在的接口，将合并返回数据的 response，适用于导入了 swagger 数据，保留对数据结构的改动

完全覆盖：不保留旧数据，完全使用新数据，适用于接口定义完全交给后端定义

5 测试集合

在项目中先创建测试集，每一个测试集是一次单元测试的主体，测试集下包含多个测试用例。

如果对某一个接口进行不同参数的多次测试，可以点击“克隆用例“后修改参数。

测试用例中内置了多中快捷判断断言，可以点击使用或者在此基础上修改。

对测试集合选择用例环境进行全case的测试，并生成测试报告:

6 成员管理

可以为项目添加不同角色的用户

7 变更通知

在主页面关注某一个项目，该项目内接口发生变化后会通过邮件的方式将增量的方式通知给你。

8 项目文档

虽然接口本身已经具备很好的可读性，但是还是欢迎大家将项目重要的信息维护到yapi内置的wiki中。

以上是对YAPI入门级的使用建议，更深入的了解请阅读

https://hellosean1025.github.io/yapi/documents/index.html

YAPI工具入门手册相关推荐

以太坊入门手册（附各类工具链接）
本文将围绕以太坊,介绍相关基础知识,提供各种查询工具.社群链接,帮助大家更加深入学习以及在以太坊上进行开发. 从 2008 年诞生以来,区块链走过了十多年的风雨路,繁衍出比特币.以太坊.EOS等诸多公 ...
React 入门手册
大家好,我是若川.推荐这篇可收藏的React入门手册.也推荐之前一篇类似的文章<如何使用 React 和 React Hooks 创建一个天气应用>. 点击下方卡片关注我.加个星标 Rea ...
figma客户端_小白的Figma入门手册
全世界都在用Figma 不知道你们有没有这种感觉,仿佛有一天,很突然的,全世界都在使用figma,一个软件从无人问津到现在的如日中天,用了不到3年,而现在,它不仅仅是当下的最优生产力工具,在疫情掀起的 ...
Medusa(美杜莎)和Hydra(九头蛇)快速入门手册：02
本文是Medusa和Hydra快速入门手册的第二部分,第一部分的传送门这两篇也是后续爆破篇的一部分,至于字典,放在最后,后续会把祖传的几十G字典准备好 Hydra入门使用手册 vanHauser Th ...
JQuery入门手册（学习笔记整理）
JQuery入门手册基础学习重点技术介绍 jQuery使用 jQuery对象与DOM对象的区别 jQuery对象与DOM对象转换选择器选择器语法基本选择器层级选择器 input标签选择器 ...
零基础小白的大数据入门手册
零基础小白的大数据入门手册,学大数据前,大家可能听过不少说大数据难学.入行做好心理准备的.大家听完也很动摇很犹豫,怀疑自己能不能学好大数据.这其实完全没有必要,觉得一个东西难,百分之八十的原因是你不了 ...
群晖nas存储系统原理_群晖NAS非官方入门手册篇十三：今夜来谈群晖---缓存、NAS和SSD那些事...
群晖NAS非官方入门手册篇十三:今夜来谈群晖---缓存.NAS和SSD那些事 2020-11-20 19:31:49 125点赞 1176收藏 199评论你是AMD Yes党?还是intel和NV ...
支付宝前端团队整理的《Web 前端开发入门手册》
[回复"1024",送你一个特别推送] 今天是元宵节,首先祝大家元宵节快乐.但是,我万万没想到的是,一个元宵节现在都能成为我们程序猿的节日,名曰:猿宵节. 真的是越来越佩服我们程序 ...
Eclipse Android开发入门手册
Eclipse Android开发入门手册资源下载 http://tools.android-studio.org jdk,Android SDK,开发工具eclipse.Android studi ...
AI产品经理入门手册（下）
近两年来AI产业已然成为新的焦点和风口,各互联网巨头都在布局人工智能,不少互联网产品经理也开始考虑转型AI产品经理,本文作者也同样在转型中.本篇文章是通过一段时间的学习归纳总结整理而成,力图通过这篇文 ...

YAPI工具入门手册

1 登陆

2 项目创建

3 接口创建

4 Swagger的导入

5 测试集合

6 成员管理

7 变更通知

8 项目文档

YAPI工具入门手册相关推荐

最新文章

热门文章