YApi接口管理平台的使用介绍

  上一篇介绍了YApi接口管理平台的搭建 传送门，因为技术领导觉得有必要写一份文档给团队，然后介绍YApi平台的使用，所以我准备写一篇文章，这里参照了YApi官方教程。

第一步：

• 第一次进入YApi平台，点击“登录/注册”，然后点击“注册”，填写账号信息。

• 然后登录账号进入平台首页。

• 在右上角点击“个人中心”，修改账户信息，一般需要把用户名修改成自己的名字，方便团队管理，根据需要修改自己的密码。

• 对于管理员，在第一次创建项目之前，需要先创建分组，以方便管理成员。

• 可以指定组长。

  

• 在“项目列表”选项下，点击“添加项目”。

• 完善项目信息，项目权限设置为“私有”。

• 项目选项栏。

• 对于管理员和组长，需要先添加成员。点击“成员管理”，然后添加成员，这里添加的成员是所属组的成员，这里也可以批量导入成员，导入其他项目的全体成员。

  

• 根据用户名来添加成员。

  

第二步：

  对于项目的一些基本设置就介绍完了，这里开始介绍添加接口和测试接口。

• 在添加接口前，可以先添加分类，比如“用户管理”。

• 然后在“用户管理”添加接口。

• 然后在“查询用户列表”接口，点击“编辑”，对这个接口进行添加请求参数和返回参数。

• 返回数据设置

• 返回值设置默认值、返回值的范围。

  

  

• 对于是string类型的字段，可以使用正则表达式和格式化。

  

• 除了可以手动添加返回数据以外，还可以导入json数据来定义返回值。

  

• 添加测试集合。

• 为了方便测试，我们需要添加环境配置，添加mock、测试、正式环境。点击“设置” >“环境配置‘。

• 在平台mock测试时，浏览器需要先安装 cross-request 插件。

• 然后进行测试。

• 添加mock期望,自定义mock数据。

• 如果mock期望不能满足要求，可以编写mock脚本。

请求 Mock 数据时，规则匹配优先级：Mock 期望 > 自定义 Mock 脚本 > 项目全局 mock 脚本 > 普通 Mock。

如果前面匹配到 Mock 数据，后面 Mock 则不返回。

返回：

  先就介绍到这里了，如果不熟悉mockjs的同学可以去看一下mockjs练习样例 mockjs.com

• yapi接口平台