swammdoc接口文檔自動生成工具

swammdoc

接口文檔自動生成工具

如圖：

團(tuán)隊(duì)協(xié)作離不開約定，規(guī)范，最早我們用word，excel編寫接口文檔，現(xiàn)在有了開源，涌現(xiàn)了一批接口文檔管理平臺， rap ， 小幺雞， apiManager等等， 有了更友好結(jié)構(gòu)化展示，版本歷史， mock等等好用功能。

問題來了， 寫好了代碼怎么維護(hù)到api管理平臺上，只能手工操作。或者自已定義一套注解庫，用來標(biāo)識請求參數(shù)，返回參數(shù)，這樣對代碼的侵入性又有點(diǎn)太強(qiáng)了。

javadoc 這個(gè)功能似乎被我們怱略了，連身邊朋友都沒見有人在用這個(gè)。javadoc 提供了很強(qiáng)勁的分析源碼的功能，參數(shù)類型， 返回類型， 泛型等等，統(tǒng)統(tǒng)可以取到， 請求參數(shù)，返回參數(shù)出現(xiàn)循環(huán)引用問題， 目前限制到4層。

第一個(gè)版本對接了rap ， 后來在使用過程中，rap越來越慢，最后遷到小幺雞，原來內(nèi)部使用shell腳本執(zhí)行， 這一個(gè)版本使用maven 插件的形式，現(xiàn)在還處理初級階段，有興趣的朋友可以修改，自己使用。

有興趣的朋友可以了解一下javadoc的使用方式， 這個(gè)工具使用也是建立在javadoc之上，maven插件也是在maven javadoc 插件的基礎(chǔ)上。