Introduce

smart-doc是一款同時支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業(yè)內(nèi)率先提出基于JAVA泛型定義推導的理念， 完全基于接口源碼來分析生成接口文檔，不采用任何注解侵入到業(yè)務代碼中。你只需要按照java-doc標準編寫注釋， smart-doc就能幫你生成一個簡易明了的Markdown、HTML5文檔，甚至可以直接生成Postman Collection導入到Postman做API接口調(diào)試。

Features

• 零注解、零學習成本、只需要寫標準JAVA注釋。
• 基于源代碼接口定義自動推導，強大的返回結(jié)構(gòu)推導。
• 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller書寫方式)、Feign。
• 支持Callable、Future、CompletableFuture等異步接口返回的推導。
• 支持JavaBean上的JSR303參數(shù)校驗規(guī)范，包括分組驗證。
• 對JSON請求參數(shù)的接口能夠自動生成模擬JSON參數(shù)。
• 對一些常用字段定義能夠生成有效的模擬值。
• 支持生成JSON返回值示例。
• 支持從項目外部加載源代碼來生成字段注釋(包括標準規(guī)范發(fā)布的jar包)。
• 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。
• 輕易實現(xiàn)在Spring Boot服務上在線查看靜態(tài)HTML5 api文檔。
• 開放文檔數(shù)據(jù)，可自由實現(xiàn)接入文檔管理系統(tǒng)。
• 支持導出錯誤碼和定義在代碼中的各種字典碼到接口文檔。
• 支持Maven、Gradle插件式輕松集成。
• 支持Apache Dubbo RPC接口文檔生成。

Smart-doc生成文檔效圖

接口頭部效果圖

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

請求參數(shù)示例

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

響應參數(shù)示例

html文檔效果圖

html文檔

項目地址

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