Welcome to the api-doc wiki!

smartlion 發布于2019-08-16 18:00 / 1017人閱讀

摘要：初衷原因很簡單，最主要是簡化接口文檔的編寫對接口的修改更加快速的可見主要作用主要功能是生成文檔它拓展了標準注釋，無需使用注解，減少了入侵。使用類加載主要是為了，更加準確對源碼進行解析利用反射。更多持久化方案，如等支持

初衷

原因很簡單，最主要是

簡化接口文檔的編寫

對接口的修改更加快速的可見

主要作用

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

云服務器 GPU云服務器 welcome the sdp for the webrtc Wiki

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/74884.html

淺談Http模塊，Express和Koa實現http服務

摘要：每個中間件可以從實例，接收三個參數，依次為對象代表請求對象代表回應，回調函數代表下一個中間件。等方法除了在回調函數內部判斷請求的網址，方法也允許將請求網址寫在第一個參數。前言利用node直接實現服務器是運用http模塊，Express和Koa都是在其上做的封裝，這篇wiki只是想直觀的看看封裝前后基本使用上的不同，先不去考慮深入的東西。一、http模塊 1.1 處理get請求 v...

CoorChice 2019-08-20 16:06 評論0 收藏0
PHP&Nginx&Mysql on Mac

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...

Genng 2019-07-25 13:34 評論0 收藏0
PHP&Nginx&Mysql on Mac

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...

MSchumi 2019-06-27 11:29 評論0 收藏0
【譯】CodeIgniter HMVC模塊擴展使用文檔

摘要：和模塊分離類似，模塊擴展使得模塊變得可便攜的。模塊化意味著模塊化。但是，模塊擴展更進一步，它允許這些模塊互相通信。 CodeIgniter HMVC擴展說明原文地址：Modular Extensions - HMVC 模塊擴展——HMVC 模塊擴展讓CodeIgniter框架模塊化。模塊是一組獨立的組件（通常有模型、控制器和視圖），它們被分類在應用模塊的子文件夾中，并且能夠直接拖到其...

teren 2019-06-27 11:47 評論0 收藏0
Python2.x 字符編碼終極指南

摘要：值得注意的是，有的編碼方案不一定能表示某些信息，這時編碼就會失敗，比如就不能用來表示中文。數組的每一項是一個字節，用來表示。所以對于字符串來說，其長度等于編碼后字節的長度。所以，讓來編碼解碼中文，就超出了其能力范圍。在人機交互之字符編碼一文中對字符編碼進行了詳細的討論，并通過一些簡單的小程序驗證了我們對于字符編碼的認識。但僅了解這篇文章的內容，并不能幫我們在日常編程中躲過一些字符編...

Amio 2019-07-25 11:15 評論0 收藏0