摘要:初衷原因很簡單,最主要是簡化接口文檔的編寫對接口的修改更加快速的可見主要作用主要功能是生成文檔它拓展了標(biāo)準(zhǔn)注釋,無需使用注解,減少了入侵。使用類加載主要是為了,更加準(zhǔn)確對源碼進(jìn)行解析利用反射。更多持久化方案,如等支持
Welcome to the api-doc wiki!
初衷原因很簡單,最主要是
簡化接口文檔的編寫
對接口的修改更加快速的可見
主要作用api-doc 主要功能是生成 java api 文檔, 它拓展了JavaDoc 標(biāo)準(zhǔn)注釋,無需使用注解,減少了入侵。同時,可以規(guī)范你的java 文檔規(guī)范.
原理首先感謝,javaparser,本項目采用javaparser 進(jìn)行 java源碼掃描,同時,對其源碼進(jìn)行簡單拓展使其支持了自定義的javaDocTag,簡化開發(fā),修改版的javaparser詳見這里。
其次,除了使用源碼掃描工具之外,為了對項目代碼的入侵,還自定義了一個簡單的類加載器,用戶只需自定義web項目路徑以及預(yù)輸出路徑即可啟動。
使用類加載主要是為了,更加準(zhǔn)確對源碼進(jìn)行解析(利用反射)。
Get Start
Java Doc Tag
JavaParser
demodemo
由于是端午節(jié)這三天寫出來的草圖,很多功能還不夠完善,我這里有一些已知的問題:
[ ] @ResponseBody 的支持,
[ ] Set,List等集合的支持
[ ] 熱加載問題(目前每需要全面進(jìn)行掃描,存在很大的浪費)
[ ] 自動加載的問題,這個其實與熱加載一樣,與git集成
[ ] Mock,前后端mock 數(shù)據(jù),
[ ] 修改問題,解析出來的東西也只是草圖,也需要進(jìn)行調(diào)整。
[ ] 更多持久化方案,如markdown,json,mongodb 等支持
Referencedependencies:
javaParser
yapi
git hook
java doc
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/74884.html
摘要:每個中間件可以從實例,接收三個參數(shù),依次為對象代表請求對象代表回應(yīng),回調(diào)函數(shù)代表下一個中間件。等方法除了在回調(diào)函數(shù)內(nèi)部判斷請求的網(wǎng)址,方法也允許將請求網(wǎng)址寫在第一個參數(shù)。 前言 利用node直接實現(xiàn)服務(wù)器是運用http模塊,Express和Koa都是在其上做的封裝,這篇wiki只是想直觀的看看封裝前后基本使用上的不同,先不去考慮深入的東西。 一、http模塊 1.1 處理get請求 v...
Install Port https://guide.macports.org/ Path You can also add the following line to your ~/.bash_profile: export PATH=/opt/local/bin:$PATH // use the port command first , dont use system command then...
Install Port https://guide.macports.org/ Path You can also add the following line to your ~/.bash_profile: export PATH=/opt/local/bin:$PATH // use the port command first , dont use system command then...
摘要:和模塊分離類似,模塊擴(kuò)展使得模塊變得可便攜的。模塊化意味著模塊化。但是,模塊擴(kuò)展更進(jìn)一步,它允許這些模塊互相通信。 CodeIgniter HMVC擴(kuò)展說明 原文地址:Modular Extensions - HMVC 模塊擴(kuò)展——HMVC 模塊擴(kuò)展讓CodeIgniter框架模塊化。模塊是一組獨立的組件(通常有模型、控制器和視圖),它們被分類在應(yīng)用模塊的子文件夾中,并且能夠直接拖到其...
摘要:值得注意的是,有的編碼方案不一定能表示某些信息,這時編碼就會失敗,比如就不能用來表示中文。數(shù)組的每一項是一個字節(jié),用來表示。所以對于字符串來說,其長度等于編碼后字節(jié)的長度。所以,讓來編碼解碼中文,就超出了其能力范圍。 在人機(jī)交互之字符編碼 一文中對字符編碼進(jìn)行了詳細(xì)的討論,并通過一些簡單的小程序驗證了我們對于字符編碼的認(rèn)識。但僅了解這篇文章的內(nèi)容,并不能幫我們在日常編程中躲過一些字符編...
閱讀 3020·2021-10-12 10:12
閱讀 3073·2021-09-22 16:04
閱讀 3306·2019-08-30 15:54
閱讀 2616·2019-08-29 16:59
閱讀 2929·2019-08-29 16:08
閱讀 880·2019-08-29 11:20
閱讀 3503·2019-08-28 18:08
閱讀 661·2019-08-26 13:43