在多产品开发中，往往有多个项目和多个应用服务需要进行管理，尤其在前后端分离和微服务化的开发场景下，API 接口数量众多，且分属项目和开发人员不同，为协作开发和项目管理带来了不少困难，一个易用的 API 管理平台成为产品开发过程中必不可少的工具。YApi 作为一个高效、易用，且功能强大的 API 管理平台，提供了可视化的图形界面，使得开发人员可以轻松管理不同的开发项目、接口文档和接口维护，大大提高了开发效率。

简介

YApi，是 YMFE 在 Github 上开源的可视化接口管理平台，项目位于 https://github.com/YMFE/yapi，目前版本为 v1.9.2。 YApi 是高效、易用、功能强大的 API 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

安装

YApi 使用 Node.js 开发，在本地部署，环境要求：Node.js 7.6+，MongoDB 2.6+，Git，可以使用项目提供的 yapi-cli 工具进行安装部署：

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

输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定 url, 点击登录输入刚才设置的管理员邮箱，默认密码为 ymfe.org 来登录系统（默认密码可在个人中心修改）。

YApi 使用 pm2 管理和维护服务：

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 //重启服务

YApi 的版本升级也十分方便，不会影响已有的项目数据：

cd  {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本

示例

YApi 使用简单，可以在内网部署，以供开发团队使用。部署完成后，团队成员注册账号后登录，进入首页，首页展示了分组与项目。可以搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。

1. 首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。
2. 首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。
3. 首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。
4. 点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。

点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。

1. 项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。
2. 点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。
3. 点击左侧的 “测试集合” 使用测试集功能。
4. 点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。
5. 点击二级导航的“动态”，即可查看项目的操作日志。

鼠标移动到右上角的用户头像或用户名上，即可点击“个人中心”查看个人信息。在个人信息页面可以查看并修改自己的用户名、密码等信息。

YApi 管理接口十分简单，可以在项目中添加接口。点击一个项目，进入该项目的详情页。点击左侧接口分组右侧的菜单按钮，选择 添加接口，或者点击接口列表右上角的 添加接口。

选择接口分类，输入接口名称和接口路径，点击 提交。

至此，就创建了一个 YApi 的接口，可以看到在左侧看到接口名称，右侧有该接口的信息预览。

对于接口，可以配置 Mock 接口，使用 JSON Schema 定义接口测试数据和响应，即可完成一个 Mock 接口的部署，可以利用该接口进行测试开发。

总结

YApi 作为一个接口管理平台，其上手简单、功能强大，降低了接口众多、管理混乱带来的额外时间消耗，大大提高开发项目的管理效率。目前，YApi 已被广泛应用，成为项目管理的重要基础工具之一，十分值得在实践中应用。