smart-doc是一個java restful api文檔生成工具,smart-doc顛覆了傳統類似swagger這種大量採用註解侵入來生成文檔的實現方法。smart-doc完全基於介面源碼分析來生成介面文檔,完全做到零註解侵入,你只需要按照java標準註釋的寫就能得到一個標準的markdown介面文檔。如果你已經厭倦了swagger等文檔工具的註解和強侵入污染,那請擁抱smart-doc吧!
零註解、零學習成本、易集成、只需要寫標準java註釋。
基於源代碼介面定義自動推導(唯一實現對象關聯無限級自推導)。
支持Spring MVC,Spring Boot。
目前支持javabean上定義的部分fastjson和jackson註解。
支持javabean上基於jsr303參數檢驗判斷參數是否為必須。
對json請求參數的介面能夠自動生成模擬json參數。
對一些常用欄位定義能夠生成有效的模擬值。
支持生成json返回值示例。
支持從項目外部載入源代碼來生成欄位註釋。
一款代碼註釋檢測工具,不寫註釋的小夥伴逃不過法眼了。
升級smart-doc依賴的基礎庫。
增加對普通的get請求參數拼裝示例的生成。
增加spring mvc佔位符restful url請求示例生成。
目前軟體功能不斷迭代,smart-doc的原始用戶強烈建議升級到最新版。
目前smart-doc一些重要的功能已經完成開發,節後會發布下一個重大版本。下一次升級將意味著它將會為更多的開發者提供服務,
將會真正意義上成為眾多java web開發者首選的api doc生成工具,也意味著留給swagger的時間不多了,需要的小夥伴請趕緊收藏好,。下一版功能預告(已進入測試階段):
新增Spring Boot Web Flux(controller書寫方式)。
新增Callable,Future,CompletableFuture等非同步介面返回的推導支持。
修改過去版本中smart-doc生成文檔中的一些細節。
重點:新增生成靜態html書籤式api文檔的功能實現在線查看api文檔(可先預覽smart-doc提供demo中的html文檔)
使用demo輕鬆玩轉介面文檔生成
[admin
]