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

简介: YApi  YApi是由去哪儿网移动架构组(简称YMFE,一群由FE、iOS和Android工程师共同组成的最具想象力、创造力和影响力的大前端团队)开源的可视化接口管理工具,一个可本地部署的、打通前后端及QA的接口管理平台,YApi旨在为开发、产品和测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布和维护不同项目,不同平台的API。

YApi

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

img_0d3242a39ad590d2bb7a956b4692483d.png
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),输入相应的配置并点击开始部署。

img_665312d9f1b17fc94076534dd7df9dda.png
YApi平台部署

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

img_7870beb47eede062c65be852d30c5cd2.png
部署日志

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 ,初始管理员账号:admin@admin.com,密码:ymfe.org(可在个人中心修改)。

img_eefc9ab36be24ff7e24436c4895b9b52.png
YApi - Login
img_1710e987213ad0fa5c42057a8297b0d7.png
YApi - 主界面

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

相关链接

YApi - 官网
YApi - GitHub

目录
相关文章
|
NoSQL Cloud Native 数据可视化
云原生之使用Docker部署YApi接口管理服务平台
云原生之使用Docker部署YApi接口管理服务平台
526 0
云原生之使用Docker部署YApi接口管理服务平台
|
4月前
|
数据可视化 JavaScript NoSQL
搭建接口平台YApi详解(含搭建node环境)
搭建接口平台YApi详解(含搭建node环境)
144 0
|
12月前
|
Web App开发 JSON 安全
【漏洞复现】Yapi接口管理平台远程代码执行漏洞
Yapi接口管理平台远程代码执行漏洞,攻击者可通过特定Payload对目标实施恶意攻击,获取敏感信息,操控服务器指令。
401 1
|
前端开发 数据可视化 机器人
基于YAPI的接口工作流
基于YAPI的接口工作流
452 0
基于YAPI的接口工作流
|
存储 NoSQL JavaScript
Linux下快速搭建YApi接口管理平台
目录 一、序言 二、安装Node 1、安装nvm 2、使用兼容的Node版本 二、安装MongoDB 1、下载MongoDB 2、配置MongoDB 三、安装YApi 四、安装PM2管理Node服务 五、登录YApi后台
Linux下快速搭建YApi接口管理平台
|
数据可视化 数据管理 测试技术
02 提效工具之yapi接口生成
02 提效工具之yapi接口生成
|
XML JSON 前端开发
开源的YAPI外还有哪些免费的接口工具?
API 管理这个话题近些年听到的频次越来越多,这本质上是个 web 领域的发展有关,也和开发协作方式有关--前后端分离代替了全栈工程师 hold all 的局面,强调的更多的是 API 复用、分工和协作细化。 API 管理的重要性不言而喻,每家公司随着业务的发展,多多少少都会涉及到;从开源社区的产品到国内各类商业化产品,可以看到大家对于 API 管理是越来越重视的。
|
Web App开发 JSON 前端开发
YApi 官网说明文档-接口操作
为方便和前端, 节省沟通成本, 编写接口文档非常有比较 使用过swagger, 觉得入侵性太大. POST又感觉和项目结合的不太紧密. 所以一直在寻找 新的接口阅读/生成/测试工具. 下面介绍一下YApi.
1666 0
YApi 官网说明文档-接口操作
|
Kubernetes 数据可视化 测试技术
可视化接口管理平台 YApi,让你轻松搞定 API 的管理问题
高效、易用、功能强大的可视化接口管理平台 YApi,让我们能轻松帮助我们搞定 API 的管理问题。
660 1
|
JSON 前端开发 API
接口管理工具YApi怎么用?颜值高、易管理、超好用
接口管理工具YApi怎么用?颜值高、易管理、超好用