Welcome to the api-doc wiki!

Welcome to the api-doc wiki!

初衷

緣由很簡單，最主要是

• 簡化接口文檔的編寫
• 對接口的修改更加快速的可見

主要做用

api-doc 主要功能是生成 java api 文檔, 它拓展了JavaDoc 標準註釋，無需使用註解，減小了入侵。同時，能夠規範你的java 文檔規範.

原理

首先感謝，javaparser，本項目採用javaparser 進行 java源碼掃描，同時，對其源碼進行簡單拓展使其支持了自定義的javaDocTag,簡化開發，修改版的javaparser詳見這裏。

其次，除了使用源碼掃描工具以外，爲了對項目代碼的入侵，還自定義了一個簡單的類加載器，用戶只需自定義web項目路徑以及預輸出路徑便可啓動。
使用類加載主要是爲了，更加準確對源碼進行解析(利用反射)。

使用文檔

• Get Start
• Java Doc Tag
• JavaParser

demo

demo

TODO LIST

因爲是端午節這三天寫出來的草圖，不少功能還不夠完善，我這裏有一些已知的問題:

• [ ] @ResponseBody 的支持，
• [ ] Set,List等集合的支持
• [ ] 熱加載問題(目前每須要全面進行掃描，存在很大的浪費)
• [ ] 自動加載的問題，這個其實與熱加載同樣，與git集成
• [ ] Mock，先後端mock 數據，
• [ ] 修改問題，解析出來的東西也只是草圖，也須要進行調整。
• [ ] 更多持久化方案，如markdown,json,mongodb 等支持

Reference

dependencies:

• javaParser
• yapi
• git hook
• java doc