smart-doc 1.9.6 發布,Java 零註解 API 文檔生成工具

2021-01-11 開源中國

smart-doc是一款同時支持java restful api和apache dubbo rpc接口文檔生成的工具,smart-doc顛覆了傳統類似swagger這種大量採用註解侵入來生成文檔的實現方法。 smart-doc完全基於接口源碼分析來生成接口文檔,完全做到零註解侵入,你只需要按照java標準注釋編寫,smart-doc就能幫你生成一個簡易明了的markdown 或是一個像GitBook樣式的靜態html文檔。如果你已經厭倦了swagger等文檔工具的無數註解和強侵入汙染,那請擁抱smart-doc吧!

功能特性 零註解、零學習成本、只需要寫標準java注釋。 基於原始碼接口定義自動推導,強大的返回結構推導。 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller書寫方式)。 支持Callable,Future,CompletableFuture等異步接口返回的推導。 支持JavaBean上的JSR303參數校驗規範,支持分組驗證。 對json請求參數的接口能夠自動生成模擬json參數。 對一些常用欄位定義能夠生成有效的模擬值。 支持生成json返回值示例。 支持從項目外部加載原始碼來生成欄位注釋(包括標準規範發布的jar包)。 支持生成多種格式文檔:Markdown、HTML5、Asciidoctor、Postman collection、Open Api 3.0+。 輕易實現在Spring Boot服務上在線查看靜態HTML5 api文檔。 開放文檔數據,可自由實現接入文檔管理系統。 一款代碼注釋檢測工具,不寫注釋的小夥伴逃不過法眼了。 插件式快速集成(支持maven和gradle插件)。 支持apache dubbo rpc文檔生成。

Smart-doc vs Swagger

 smart-doc不是對Swagger造輪子,這是一款用完全不同的理念重新開發的restful api接口文檔生成工具。  smart-doc比swagger集成更簡單,可以自由生成多種格式的api文檔。  smart-doc完全不需要在侵入到業務代碼中寫任何註解,插件化集成到項目。  smart-doc提供了許多swagger沒有 的功能,例如:字典碼、業務錯誤碼導出到文檔,dubbo rpc接口文檔生成。 smart-doc完全支持swagger指定的標準open api 3.0+規範。 smart-doc對於企業來說提供了比swagger更多的擴拓展能力,例如用smart-doc開放的數據自己開發生成性能測試腳本等。更新內容

1. 修復RequestParam 解析錯誤。
2. 修復泛型中使用?時的解析錯誤。
3. 修改服務url的地址為空字符串,不再提供默認http前綴
4. 增加泛型實際類型的顯示開關控制。
5. 修復類繼承一個泛型類時的解析錯誤。
6. 優化smart-doc maven插件,提升用戶在多模塊下的使用體驗。

maven或gradle插件

smart-doc官方為了方便用戶快速和無侵入的集成smart-doc的文檔api生成能力,我們開發可相關的maven或者gradle插件。這裡也推薦使用插件的方式來使用smart-doc。

https://gitee.com/smart-doc-team/smart-doc-maven-plugin

升級建議

   修復了用戶反饋的一些bug,本次升級不涉及到api的變更,重點:本次發布的新版maven插件在多模塊中更加智能,用戶體驗提升很大。

DEMO

使用demo輕鬆玩轉接口文檔生成,其他用戶案例文檔效果展示:https://api.doubans.com/

知名用戶

相關焦點