smart-doc 是一個 java restful api 文檔生成工具，smart-doc 顛覆了傳統類似 swagger 這種大量採用註解侵入來生成文檔的實現方法。 smart-doc 完全基於接口源碼分析來生成接口文檔，完全做到零註解侵入，你只需要按照java標準註釋的寫，smart-doc 就能幫你生成一個簡易明瞭的 Markdown、Html、AsciiDoc 文檔。
如果你已經厭倦了 swagger 等文檔工具的無數註解和強侵入汙染，那請擁抱 smart-doc吧！喜歡 smart-doc 的用戶也不要忘記給項目 star，你們的支持是 smart-doc 持續推進的動力。
功能特性
- 零註解、零學習成本、只需要寫標準java註釋。
- 基於源代碼接口定義自動推導，強大的返回結構推導。
- 支持 Spring MVC、Spring Boot、Spring Boot Web Flux(controller 書寫方式)。
- 支持 Callable、Future、CompletableFuture 等異步接口返回的推導。
- 支持 JavaBean 上的 JSR303 參數校驗規範。
- 對 json 請求參數的接口能夠自動生成模擬 json 參數。
- 對一些常用字段定義能夠生成有效的模擬值。
- 支持生成 json 返回值示例。
- 支持從項目外部加載源代碼來生成字段註釋(包括標準規範發佈的 jar 包)。
- 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor。
- 輕易實現在 Spring Boot 服務上在線查看靜態 HTML5 api 文檔。
- 開放文檔數據，可自由實現接入文檔管理系統。
- 一款代碼註釋檢測工具，不寫註釋的小夥伴逃不過法眼了。
- 支持導出錯誤碼和定義在代碼中的各種枚舉字典到接口文檔。
Smart-doc vs Swagger
- smart-doc 不是對 Swagger 造輪子，這是一款用完全不同的理念重新開發的 restful api 接口文檔生成工具。
- smart-doc 比 swagger 集成更簡單，可以自由生成多種格式的 api 文檔。
- smart-doc 完全不需要在侵入到業務代碼中寫任何註解，複雜嵌套對象自動推導出定義字段結構。
- smart-doc 代碼量很少，如果不能滿足你的需求完全可以自己修改源碼。
更新內容
- fix #I14PT5 header 重複渲染到文檔
- fix #I14MV7 不設置 dataDictionaries 出現空指針錯誤
- 增加請求參數枚舉字段解析(試用功能)
升級建議
這個一個跟進用戶提交的 issues 修復的版本，建議升級到最新版本避免一些 bug
DEMO
使用 demo 輕鬆玩轉接口文檔生成 demo地址：https://github.com/shalousun/api-doc-test
文章轉載自 OSCHINA 社區 [http://www.oschina.net]
本文標題：smart-doc 1.7.6 發佈，Java 零註解文檔生成工具
本文地址：https://www.oschina.net/news/111321/smart-doc-1-7-6-released
分享到:
閱讀更多 達升笑聊IT 的文章
