smart-doc是一個java restful api文檔生成工具, smart-doc完全基於介面源碼分析來生成介面文檔,完全做到零註解侵入,你只需要寫上java的標準註釋,smart-doc就能幫你生成一個簡易明了的Markdown、Html、AsciiDoc文檔和Postman json一鍵導入的測試數據。如果你不喜歡其他工具強侵入的註解污染,smart-doc給你一個不錯的選擇!喜歡smart-doc的用戶也不要忘記給項目star,你們的支持是smart-doc持續推進的動力。
Smart-doc vs Swagger
1. 響應用戶需求,對spring的表單參數綁定做了全面的支持,smart-doc不再是僅僅支持json參數。
2. 合併fork分支的github book html5模板,新增搜索和錨點。
3. 新增自定義@mock tag用於指定生成文檔時的默認欄位值,@param 的參數註釋增加mock值的解析功能(@param name 姓名|張三),
此項改進可以滿足用戶直接使用smart-doc生成交付給第三方公司的對接文檔。
4. smart-doc-maven-plugin插件增強對maven標準項目的支持(插件仍然存在一些問題,當前未找到解決辦法)。
5. 對生成的postman json數據做了全面的增強,無論是json還是表單參數,導出的postman json可以一鍵導入postman自動完成參數列表回填。
6. 優化對實體類中枚舉欄位的支持。
7. 增加對實體中靜態常量常量欄位的過濾。
從smart-doc 1.7.9版本開始。我們提供了smart-doc的插件smart-doc-maven-plugin,目前該插件只做試用。
本次主要是對錶單參數和postman數據導出做了增強。也修改了一起bug和部分源碼做了重構,建議用戶升級到最新。
使用demo輕鬆玩轉介面文檔生成
[admin
]