今天研究了下一款很是好用的api集中展現工具---Yapi，具體網址 https://hellosean1025.github.io/yapi/documents/index.htmlhtml
它的做用是幫你智能的展現你的項目裏的全部接口，還能夠提示接口是開發完成仍是未完成，這樣就很是方便一些先後端分離的工做，前端人員能夠直接經過查看哪些接口是「已完成」的，前端
就能夠放心的調用，後端人員若是發現接口有異常，也能夠改成「未完成」狀態提示前端不要使用，它還包括調用參數的個數及類型，可是你須要在接口裏面寫好註釋。node
先上幾張圖給你們看一下樣子，有個直觀的瞭解git
能夠看到第一張圖中，Yapi很清晰完整的展現了全部咱們開發的接口，而後還有一個完成狀態，從第二張圖中，咱們也能夠知道調用接口須要傳什麼參數，返回的是什麼參數等等，功能很是完善。github
那麼咱們如何把它弄到本地呢，查看官網教程，以下圖mongodb
能夠看到，使用Yapi，須要安裝好mongodb（2.6+）和nodejs(7.6+)，安裝以後，打開命令行直接輸入 npm install -g yapi-cli --registry https://registry.npm.taobao.org yapi server 來安裝yapichrome
而後根據頁面提示選擇yapi的版本等信息，最後點擊部署，就部署成功了，這裏另外提一下，若是服務關閉了，重啓服務的方法是，進入到xxx/myapi的路徑下，如圖npm
而後打開命令行進入這個路徑，輸入 node vendors server app.js 便可
json
繼續往下看，這是我本地部署的一個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時間間隔
配置好保存後，刷新下去首頁接口裏面看一看，會發現你的接口都成功展現出來了。