支持 Dubbo 接口文檔生成的工具

Features

• 零注解、零學(xué)習(xí)成本、只需要寫標(biāo)準(zhǔn)JAVA注釋。

• 基于源代碼接口定義自動推導(dǎo)，強(qiáng)大的返回結(jié)構(gòu)推導(dǎo)。

• 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller書寫方式)、Feign。

• 支持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、OpenAPI 3.0。

• 輕易實現(xiàn)在Spring Boot服務(wù)上在線查看靜態(tài)HTML5 api文檔。

• 開放文檔數(shù)據(jù)，可自由實現(xiàn)接入文檔管理系統(tǒng)。

• 支持導(dǎo)出錯誤碼和定義在代碼中的各種字典碼到接口文檔。

• 支持Maven、Gradle插件式輕松集成。

• 支持Apache Dubbo RPC接口文檔生成。

Smart-doc生成文檔效圖

接口頭部效果圖

請求參數(shù)示例效果圖

響應(yīng)參數(shù)示例效果圖

html文檔效果圖

開源地址：https://gitee.com/smart-doc-team/smart-doc