比Swagger2更好用的自動生成文檔工具?對比流程說話!


肯定會有同學問為什么要自動生成文檔,老慣例先解釋一下應用場景。
現在的開發模式,通常都是先寫接口文檔再開發接口,但是需求不是一成不變的,接口也會有修改。相應的,改完接口就要改文檔,這種時候會出現什么問題呢?沒錯了,接口文檔會沒有及時改或者忘了改。
所以就要想辦法了啊,怎么改接口就自動生成對應的文檔呢?那時候也是在某社區看到的帖子,然后就開始用Swagger2對應的自動生成接口文檔功能了。
然后最近因為部門其他組的安利,換了個工具叫Eolinker,發現比Swagger簡單不少,還支持直接通過Swagger導入API項目,幫助我們自己小組也解決了換工具麻煩的問題。

Swagger自動生成文檔流程

我們當時是用Spring boot來做的,算是搭建比較快的,分為3步:
1.在pom.xml中添加依賴;
2.編寫Swagger2的config;
3. 在controller中添加注解。

下面是實際的效果圖。

Eolinker自動生成文檔流程

使用Eolinker,只需要直接敲代碼,符合正確的規范就可以自動生成接口文檔,下面是幾種比較簡單的方法。
1.根據代碼模板自動生成,直接新建模板編輯填入就可以在需要的時候自動生成;

2.導入/關聯其他API工具自動生成,支持識別Swagger2、碼雲、github等;

下面是實際的效果圖。

總結

Eolinker算是國產API工具里開發功能和后續支持服務都做得挺好的了,之前Swagger出了問題等客服的反饋真的一言難盡。我們用的是免部署的Saas版本,可能過段時間在公司內推開了會轉成私有化部署的,強烈安利一下大家也可以試用一下。
使用地址:www.eolinker.com


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM