使用Yapi展示你的api接口

　　今天研究了下一款非常好用的api集中展示工具---Yapi，具体网址 https://hellosean1025.github.io/yapi/documents/index.html

它的作用是帮你智能的展示你的项目里的所有接口，还可以提示接口是开发完成还是未完成，这样就非常方便一些前后端分离的工作，前端人员可以直接通过查看哪些接口是“已完成”的，

就可以放心的调用，后端人员如果发现接口有异常，也可以改为“未完成”状态提示前端不要使用，它还包括调用参数的个数及类型，但是你需要在接口里面写好注释。

先上几张图给大家看一下样子，有个直观的了解

 

 

 

　　可以看到第一张图中，Yapi很清晰完整的展示了所有我们开发的接口，然后还有一个完成状态，从第二张图中，我们也可以知道调用接口需要传什么参数，返回的是什么参数等等，功能非常完善。

那么我们如何把它弄到本地呢，查看官网教程，如下图

 

 可以看到，使用Yapi，需要安装好mongodb（2.6+）和nodejs(7.6+)，安装之后，打开命令行直接输入 npm install -g yapi-cli --registry https://registry.npm.taobao.org yapi server 来安装yapi

然后根据页面提示选择yapi的版本等信息，最后点击部署，就部署成功了，这里另外提一下，如果服务关闭了，重启服务的方法是，进入到xxx/myapi的路径下，如图

然后打开命令行进入这个路径，输入 node vendors server app.js 即可

 

 

 

 

继续往下看，这是我本地部署的一个api服务，然后在yapi上面做一些简单配置就能展示，切换到“预览”菜单，我们可以看到该接口的详细情况，这个页面的内容，其实是可以拿来写接口文档的，

有了这个页面，写接口文档再也不复杂啦，另外，可以看到第三个tab菜单“运行”，切换到这里，我们可以直接测试下api是否可正常使用，不过呢，运行的时候需要chrome浏览器，而且需要谷歌

的插件支持，所以，需要科学 上网下载对应的插件，可以参考我另外的文章搭建ss或者brook。https://www.cnblogs.com/luoocean/p/11233094.html或者https://www.cnblogs.com/luoocean/p/11133848.html

 

 

 下面看下配置，首先切换到“设置”-》“环境设置”，添加一个环境配置local，如图，如果接口需要鉴权token，可以把token配在Authorization键里，保存后生效。

最后别忘了配置自动同步，想要Yapi自动识别你项目中的接口，那肯定少不了配置接口路径给它啦，看下图，开启自动同步，然后同步模式根据需求选，一般选择智能合并即可，项目路径就填swagger.json文件的路径，最后设置Cron时间间隔

 配置好保存后，刷新下去首页接口里面看一看，会发现你的接口都成功展示出来了。