好用的在線檔案生成工具，具體要求如下：
1.能夠實時生成在線檔案
2.支持全文搜索
3.支持在線除錯功能
4.界面美觀
說實話，這個需求看起來簡單，但是實際上一點的都不簡單，
我花了幾天時間到處百度，谷歌，技術博客 和 論壇查資料，先后調研了如下檔案生成工具：
一、gitbook
開發語言：javascript
用戶：50萬+
示例地址：https://www.servicemesher.com/envoy/intro/arch_overview/dynamic_configuration.html
GitBook是一款檔案編輯工具，它的功能類似金山WPS中的Word或者微軟Office中的Word的檔案編輯工具，它可以用來寫檔案、建表格、插圖片、生成pdf，當然，以上的功能WPS、Office可能做得更好，但是，GitBook還有更最強大的功能：它可以用檔案建立一個網站，讓更多人了解你寫的書，另外，最最核心的是，他支持Git，也就意味著，它是一個分布式的檔案編輯工具，你可以隨時隨地來撰寫你的檔案，也可以多人共同撰寫檔案，哪怕多人撰寫同一頁檔案，它也能記錄每個人的內容，然后告訴你他們之間的區別，也能記錄你的每一次改動，你可以查看每一次的書寫記錄和變化，哪怕你將檔案都洗掉了，它也能找回來！這就是它繼承Git后的厲害之處！
優點：使用起來非常簡單，支持全文搜索，可以跟git完美集成，對代碼無任何嵌入性，支持markdown格式的檔案撰寫，
缺點：需要單獨維護一個檔案專案，如果介面修改了，需要手動去修改這個檔案專案，不然可能會出現介面和檔案不一致的情況，并且，不支持在線除錯功能，
個人建議：如果對外的介面比較少，或者撰寫之后不會經常變動可以用這個，
二、smartdoc
用戶：小米、科大訊飛、1加
示例地址：https://gitee.com/smart-doc-team/smart-doc/wikis/檔案效果圖?sort_id=1652819
smart-doc是一個java restful api檔案生成工具，smart-doc顛覆了傳統類似swagger這種大量采用注解侵入來生成檔案的實作方法，smart-doc完全基于介面原始碼分析來生成介面檔案，完全做到零注解侵入，只需要按照java標準注釋的寫就能得到一個標準的markdown介面檔案，
優點：基于介面原始碼分析生成介面檔案，零注解侵入，支持html、pdf、markdown格式的檔案匯出，
缺點：需要引入額外的jar包，不支持在線除錯
個人建議：如果實時生成檔案，但是又不想打一些額外的注解，比如：使用swagger時需要打上@Api、@ApiModel等注解，就可以使用這個，
三、redoc
用戶：docker、redocly
示例地址：https://docs.docker.com/engine/api/v1.40/
redoc自己號稱是一個最好的在線檔案工具，它支持swagger介面資料，提供了多種生成檔案的方式，非常容易部署，使用redoc-cli能夠將您的檔案捆綁到零依賴的 HTML檔案中，回應式三面板設計，具有選單/滾動同步，
優點：非常方便生成檔案，三面板設計
缺點：不支持中文搜索，分為：普通版本 和 付費版本，普通版本不支持在線除錯，另外UI互動個人感覺不適合國內大多數程式員的操作習慣，
個人建議：如果想快速搭建一個基于swagger的檔案，并且不要求在線除錯功能，可以使用這個，
四、knife4j
用戶：未知
示例地址：http://swagger-bootstrap-ui.xiaominfo.com/doc.html
knife4j是為Java MVC框架集成Swagger生成Api檔案的增強解決方案,前身是swagger-bootstrap-ui,取名kni4j是希望她能像一把匕首一樣小巧,輕量,并且功能強悍，
優點：基于swagger生成實時在線檔案，支持在線除錯，全域引數、國際化、訪問權限控制等，功能非常強大，
缺點：界面有一點點丑，需要依賴額外的jar包
個人建議：如果公司對ui要求不太高，可以使用這個檔案生成工具，比較功能還是比較強大的，
五、Eolinker
用戶：360，中化，廣聯達，統一，柏濤
示例地址：https://www.eolinker.com/
Eolinker是國內團隊自主研發的，主要支持以下功能：
? 可視化介面管理
? 資料mock
? 自動化介面測驗
? 資料匯入（各種，包括swagger、har、postman、json、命令列）
? 權限管理
? 支持本地化部署
? 支持插件
? 支持二次開發
優點：功能非常強大，支持權限管理、在線除錯、介面自動化測驗、插件開發等，拓展性也很好，
缺點：是Saas管理工具，沒有原始碼，
個人建議：如果需求比較復雜，這個在線檔案工具還是非常好用的，筆者在這里強烈推薦一下，
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/244152.html
標籤：其他
上一篇：軟體測驗基礎知識