YMFE/yapi：可视化的接口管理平台

【Github】项目名：YMFE/yapi – 可视化接口管理平台

项目简介

YApi是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台。其体验地址为http://yapi.smart – xwork.cn/，文档在hellosean1025.github.io/yapi。它旨在为开发、产品、测试人员提供更优雅的接口管理服务，开发人员能轻松创建、发布、维护API，并且只需利用平台提供的接口数据写入工具以及简单点击操作就能管理接口，还提供了优秀的交互体验。

项目特性

• 基于Json5和Mockjs定义接口返回数据的结构和文档，效率提升多倍。
• 扁平化权限设计，兼顾大型企业级项目管理和易用性。
• 类似postman的接口调试自动化测试，支持对Response断言。
• MockServer除支持普通随机mock外，还增加Mock期望功能，根据请求过滤规则返回期望数据。
• 支持postman、har、swagger数据导入。
• 免费开源，可内网部署，保障信息安全。

安装使用

1. 内网部署环境要求nodejs（7.6+）、mongodb（2.6+）、git。
2. 使用yapi – cli工具部署YApi平台，执行yapiserver启动可视化部署程序，输入配置并点击开始部署完成网站部署。
3. 部署完成后，按提示执行node/{网站路径/server/app.js}启动服务器，在浏览器打开指定url，点击登录输入管理员邮箱（默认密码为ymfe.org，可在个人中心修改）。

服务管理

利用pm2方便服务管理维护，安装pm2（npminstall pm2 – g），进入项目目录后，可执行pm2 start “vendors/server/app.js” –name yapi（pm2管理yapi服务）、pm2 info yapi（查看服务信息）、pm2 stop yapi（停止服务）、pm2 restart yapi（重启服务）等操作。

项目升级

升级项目版本容易且不影响已有项目数据，只会同步vendors目录下的源码文件。在项目目录下，可执行yapils（查看版本号列表）、yapiupdate（更新到最新版本）、yapiupdate – v{Version}（更新到指定版本）操作。

项目总结

YApi有着丰富的功能，从接口管理到服务管理、项目升级等操作都较为便捷。无论是对于开发、产品还是测试人员，都能在这个平台上高效地进行相关工作。如果你对这个项目有任何想法或者经验，欢迎在评论区留言分享。

项目地址

GitHub链接直达