今天研究了下一款非常好用的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時間間隔
配置好保存后,刷新下去首頁接口里面看一看,會發現你的接口都成功展示出來了。