YAPI工具入门手册

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