接口文档系统 - Yapi

我们为什么需要接口文档系统？

  在我工作最初，和同事间沟通接口细节时，总是使用Word文档编写一份接口说明书。不仅编写麻烦，而且特别容易忘记更新，有些文档没有用svn等版本管理工具管理时，甚至会出现丢失的情况。

  接口文档管理系统，专为解决此类问题而生。目前市面上挺多种类的，但其宗旨离不开帮助IT人员更便捷的定义、修改、查看、甚至调用接口。

  Yapi是由去哪儿开源的一套接口管理系统，特别适合在内网搭建。GitHub地址：YAPI 。在这上面已经有很详细的介绍了，我这里主要讲讲我的踩坑经历。

Yapi搭建

  Yapi的搭建提供了两种模式：1.可视化部署 2.命令行部署

1.可视化部署

  首选，需要安装nodejs（7.6+) 与 mongodb（2.6+）。

  这里建议node.js不要安装最新版本，我第一次部署使用V16.14.0，结果各种问题。后来改用V12.22.10版本，一路顺畅~

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