Yapi简介和部署

YApi是一个可本地部署的、打通前后端及QA、可视化接口管理平台；github start：22k

平台支持可视化接口管理、mock数据、接口自动化测试、权限管理、数据导入等功能；

• 公司私有部署地址：http://yapi.rd.com; 
  • 登录用户名：admin@admin.com，密码：***
• 平台帮助文档：YApi 接口管理平台

1. 平台介绍

1.1 平台能力

1.2 产品界面

1.3 不同职能人员的使用

2. 项目部署&目标

2.1 项目部署

• 从github拉取最新的代码提交到公司gitlab，http://gitlab.rd.com/qike_qa_tools/api-design，为二次开发做准备
• 部署公司私有的平台：安装mongo、yapi；部署项目、日常运维管理
• 启客 接口管理平台地址：http://yapi.rd.com
• 登录方式：LDAP邮箱和密码

2.2 目标

• 规范接口设计、开发、测试流程，提升开发人员接口设计能力
• 搭建可视化平台，人人可查看项目接口，打破项目间认知壁垒
• 通过结构化api接口存储，提升接口自动化测试抓取和case编写效率
• 通过平台提供的mock功能，可以让开发流程更提前，联调效率提升

一、目录规划

空间：按照项目线进行定义

项目：按照空间下的git工程服务子module（pipeline部署的appname）命名

权限：项目设置为“公开”类型，用户都可以访问，写的权限通过空间成员配置和单项目成员配置完成（空间权限>项目权限）

接口管理平台地址：http://yapi.rd.com

登录方式：LDAP邮箱（xxx@qike366.com）和密码

二、常用功能介绍

1、 添加项目成员

在成员管理tab中添加项目成员

2、 配置接口环境变量

3、 测试接口

• 需要安装chrome插件crossRequest，文件见附件；安装步骤如下：
• 下载附件中的，解压；
• 使用chrome浏览器打开网址： chrome://extensions/；
• 点击左上角的【加载已解压的扩展程序】按钮，选择解压后的文件夹，即可完成插件的安装；

运行接口

如遇到有错误，chrome://extensions/，打开开发者模式，点击“背景页”，可开启控制台查看请求数据

4、mock数据

YApi支持两种方式mock数据：mockjs、高级mock（自定义脚本）；

1. mockjs方式（帮助文档）

2. 高级mock（帮助文档）

支持配置mock期望、设置接口延时、根据query自定义返回结果；

5 自动化测试

1. 配置测试集合，生成测试报告

2. 查看测试结合返回的数据

三、接口导入

HAR：fiddler抓包导出文件格式

POSTMAN：通过postman导出Collection v1数据

Swagger：swagger  url

注意：可指定导入目录

四、 注意事项

删除项目

项目一旦删除，将无法恢复数据，请慎重操作！

只有组长和管理员有权限删除项目。

测试 线上接口

因为通过平台测试，可以随意设置接口条件，可以随意修改、删除记录；

所以：非必要，不要用来测试 线上接口；

IDE使用方式：EasyYapi插件使用