YApi - 高效、易用、功能强大的可视化接口管理平台

YApi

  YApi是由去哪儿网移动架构组(简称YMFE，一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开源的可视化接口管理工具，一个可本地部署的、打通前后端及QA的接口管理平台，YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布和维护不同项目，不同平台的API。有了YApi，我们可以很方便的测试、管理和维护多个项目的API接口，不像Swagger那样是随应用生和灭的(且线上环境下大多数须关闭)，YApi是一个独立的服务平台。

 

安装YApi

1. 环境说明

• Centos7
• NodeJS v7.6+
• MongoDB v2.6+
• Git (可选)

2. NodeJS安装

  安装这个遇到点坑，因为系统是CentOS的，所以一开始很自然用上了yum -y install nodejs，没想到安装出来的node版本太低了，无奈又用命令yum remove -y nodejs npm卸载掉并重新安装，之后找到了Node官网的安装说明 ，参考操作如下：

sudo yum install gcc-c++ make

curl -sL https://dl.yarnpkg.com/rpm/yarn.repo | sudo tee /etc/yum.repos.d/yarn.repo

sudo yum install yarn

curl --silent --location https://rpm.nodesource.com/setup_10.x | sudo bash -

sudo yum -y install nodejs

3. MongoDB安装

  为了简便，这里用docker运行mongo服务。

// 1.运行mongo服务，因为是测试所以也不设置用户名密码了
docker run -d --name yapi-mongo -p 27017:27017 mongo
// 2.进入mongo服务
docker exec -it yapi-mongo bash
// 3.进入mongo交互命令环境
mongo
// 4.创建名为yapi的DB，这个在可视化部署用得上
use yapi
// 5.查看所有DB
show dbs

4.1 可视化部署及启动[推荐]

// 1. 用npm安装yapi客户端
    npm install -g yapi-cli --registry https://registry.npm.taobao.org
// 2. 启动客户端安装服务
    yapi server

  执行完第2步的yapi server后系统将自动运行可视化部署程序(http://localhost:9090)，输入相应的配置并点击开始部署。

 

  部署完成之后，根据部署日志提示信息切换到部署目录，输入指令node vendors/server/app.js启动服务器。

 

4.2 命令行部署及启动[此方法请自行测试]

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候

使用YApi

  如果部署的时候使用的是默认端口配置，那网站访问的地址就是：http://localhost:3000 ，初始管理员账号：[email protected]，密码：ymfe.org（可在个人中心修改）。

 

 

  具体的操作和使用请查看官方文档：YApi-教程，包括Mock测试、自动化测试、数据导入导出等都有详细的介绍。

相关链接

YApi - 官网
YApi - GitHub