YApi 一个神奇的接口管理平台

Posted 2021-09-26 Adorable_Rocy

前言：API接口在设计时往往需要编写大量的文档，而且编写完成后往往需要根据实际情况经常改动文档，这使得文档编写维护工作量相对较大，让很多的开发者都很头疼。

1.为什么要使用接口管理平台

• 接口版本迭代方便
• 接口维护十分方便
• 前后端同步进行
• 方便查阅接口

2.YApi管理平台

简介：

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

2.部署方式（基于nodesjs,mongodb,git）

• 方式一

使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码为 ymfe.org 登录系统（默认密码可在个人中心修改）

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server 

• 服务管理

npm install pm2 -g  //安装pm2
cd  {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

• 方式二 （https://github.com/YMFE/yapi 是开源项目）

# 如果github压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法
 mkdir yapi

 cd yapi
 
 git clone https://github.com/YMFE/yapi.git vendors 
 
 cp vendors/config_example.json ./config.json //复制完成后请修改相关配置cd vendors

 npminstall--production--registryhttps://registry.npm.taobao.org

 npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在config.json配置

 node server/app.js //启动服务器后，访问 127.0.0.1:{config.json配置的端口}，初次运行编译会比较慢