推薦一款 Java 零注解 API 文檔生成工具

smart-doc 是一款同時支持 java restful api 和 Apache Dubbo rpc 接口文檔生成的工具，smart-doc 顛覆了傳統(tǒng)類似 swagger 這種大量采用注解侵入來生成文檔的實現(xiàn)方法。

smart-doc 完全基于接口源碼分析來生成接口文檔，完全做到零注解侵入，你只需要按照 java 標(biāo)準(zhǔn)注釋編寫，smart-doc 就能幫你生成一個簡易明了的 markdown 或是一個像 GitBook 樣式的靜態(tài) html 文檔。如果你已經(jīng)厭倦了 swagger 等文檔工具的無數(shù)注解和強侵入污染，那請擁抱 smart-doc 吧！

功能特性

• 支持接口 debug。
• 零注解、零學(xué)習(xí)成本、只需要寫標(biāo)準(zhǔn) java 注釋。
• 基于源代碼接口定義自動推導(dǎo)，強大的返回結(jié)構(gòu)推導(dǎo)。
• 支持 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 書寫方式)。
• 支持 Callable,Future,CompletableFuture 等異步接口返回的推導(dǎo)。
• 支持 JavaBean 上的 JSR303 參數(shù)校驗規(guī)范，支持分組驗證。
• 對 json 請求參數(shù)的接口能夠自動生成模擬 json 參數(shù)。
• 對一些常用字段定義能夠生成有效的模擬值。
• 支持生成 json 返回值示例。
• 支持從項目外部加載源代碼來生成字段注釋(包括標(biāo)準(zhǔn)規(guī)范發(fā)布的 jar 包)。
• 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman collection、Open Api 3.0+。
• 輕易實現(xiàn)在 Spring Boot 服務(wù)上在線查看靜態(tài) HTML5 api 文檔。
• 開放文檔數(shù)據(jù)，可自由實現(xiàn)接入文檔管理系統(tǒng)。
• 一款代碼注釋檢測工具，不寫注釋的小伙伴逃不過法眼了。
• 插件式快速集成(支持 maven 和 gradle 插件)。
• 支持 Apache Dubbo rpc 文檔生成。

Smart-doc 從 2.0.0 后幾乎實現(xiàn)了 swagger ui 的功能，并且比 swagger ui 更簡潔大方，也更符合國內(nèi)開發(fā)者的訴求。當(dāng)然 smart-doc 的功能也已經(jīng)

超過了 swagger 為 java 開發(fā)者提供的功能。當(dāng)然 smart-doc 本身是只支持掃描代碼生成 openapi 3.0 的文檔的，也可以將生成的 openapi 3.0 文檔導(dǎo)入到其他ui中渲染展示。

效果圖

源碼：掃碼回復(fù)“開源014”下載

推薦閱讀：
世界的真實格局分析，地球人類社會底層運行原理
企業(yè)IT技術(shù)架構(gòu)規(guī)劃方案
論數(shù)字化轉(zhuǎn)型——轉(zhuǎn)什么，如何轉(zhuǎn)？
企業(yè)10大管理流程圖，數(shù)字化轉(zhuǎn)型從業(yè)者必備！
【中臺實踐】華為大數(shù)據(jù)中臺架構(gòu)分享.pdf
華為的數(shù)字化轉(zhuǎn)型方法論
華為如何實施數(shù)字化轉(zhuǎn)型（附PPT）
超詳細280頁Docker實戰(zhàn)文檔！開放下載
華為大數(shù)據(jù)解決方案（PPT）