如何優(yōu)雅的生成接口文檔？
說到優(yōu)雅的接口文檔，很多人不免都想到了Swagger，但是Swagger真的好嗎？眾所周知，這個框架對代碼有很大的侵入性，況且需要程序員自行開發(fā)，甚至可能會出現(xiàn)30分鐘開發(fā)完業(yè)務(wù)，1個小時寫Swagger注解的情況。
所以，Swagger不能被稱之為優(yōu)雅。那么，就不得不說一下YApi了。
YAPI，專為接口管理而生，友好的接口文檔，基于websocket的多人協(xié)作接口編輯功能和類postman測試工具，讓多人協(xié)作成倍提升開發(fā)效率。支持MockServer，基于Mock.js，使用簡單而功能強大。
項目管理YAPI可以添加分組，可以為每個分組設(shè)置組長，組員，其他人無權(quán)限訪問該分組。然后，分組內(nèi)可創(chuàng)建項目，可定義基本路徑，其實，可以簡單理解為api接口的固定前綴，不單單指上下文根。例如，可以為 /shop/api 等。
創(chuàng)建接口項目創(chuàng)建完成后，即可進入詳情頁進行后續(xù)操作。
創(chuàng)建接口也比較簡單，其內(nèi)容通俗易懂，直接填寫即可。
在設(shè)置界面，可對項目及接口進行相關(guān)設(shè)置，如域名等，也可以設(shè)置域名為本地。
還可以查看項目的動態(tài)，也就是變動日志。
如果你之前做過Swagger的集成，那么，在這里可以直接導(dǎo)入，不必一一創(chuàng)建，既貼心又方便。
還可以開發(fā)一個wiki，方便接口使用者及開發(fā)者了解項目詳情，接口邏輯。
當(dāng)然了，如果團隊成員發(fā)生變動，如新進人員、離職人員等，可以再次對項目成員進行管理。
另外，還支持MOCK配置、環(huán)境配置、全局MOCK腳本、Swagger自動同步等。
介紹至此，大家已然明白，相較于Swagger，YAPI對系統(tǒng)的侵入，可以說是零。也很符合其優(yōu)雅的接口管理系統(tǒng)美名。
關(guān)于其他更詳細的使用方面的問題，大家可下載部署安裝之后，親自嘗試嘗試，即可領(lǐng)略其魅力。
關(guān)注@銀河架構(gòu)師，發(fā)現(xiàn)更多精彩內(nèi)容。
