smart-doc是一款同時支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業(yè)內(nèi)率先提出基于JAVA泛型定義推導(dǎo)的理念， 完全基于接口源碼來分析生成接口文檔，不采用任何注解侵入到業(yè)務(wù)代碼中。你只需要按照java-doc標準編寫注釋， smart-doc就能幫你生成一個簡易明了的Markdown、Postman Collection2.0+、OpenAPI 3.0+的文檔。除此之外smart-doc還支持生成漂亮簡潔可調(diào)試的html5頁面文檔。

功能特性

• 支持生成可直接調(diào)試接口的文檔頁面(文件上傳、下載也支持)。
• 零注解、零學(xué)習(xí)成本、只需要寫標準java注釋。
• 基于源代碼接口定義自動推導(dǎo)，強大的返回結(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返回值示例。
• 支持從項目外部加載源代碼來生成字段注釋(包括標準規(guī)范發(fā)布的jar包)。
• 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman collection 2.0+、Open Api 3.0 +。
• 輕易實現(xiàn)在Spring Boot服務(wù)上在線查看靜態(tài)HTML5文檔，支持debug調(diào)試接口。
• 開放文檔數(shù)據(jù)，可自由實現(xiàn)接入文檔管理系統(tǒng)。
• 支持生成Postman Collection數(shù)據(jù)一鍵到入到Postman測試接口，參數(shù)值默認幫你填好。
• 從1.8.0版本全面支持json和表單請求解析。

• 一款代碼注釋檢測工具，不寫注釋的小伙伴逃不過法眼了。
• 支持導(dǎo)出錯誤碼和定義在代碼中的各種枚舉字典碼到接口文檔。
• Maven、Gradle插件化支持，使用極其簡單（推薦使用插件）。
• Apache Dubbo RPC接口文檔生成支持。
• JAX-RS支持

官方推薦方案

smart-doc + Torna 組成行業(yè)領(lǐng)先的文檔生成和管理解決方案，使用smart-doc無侵入完成Java源代碼分析和提取注釋生成API文檔，自動將文檔推送到Torna企業(yè)級接口文檔管理平臺

smart-doc+Torna文檔自動化

知名用戶

• 一加【oneplus】

• 科大訊飛

• 小米

• 同程旅行

• 馬蜂窩

• 東軟

• 漢得信息

Markdown工具推薦

      smart-doc目前能夠支持將文檔合并到一個Markdown文件，因此你可以使用Typora工具將Markdown轉(zhuǎn)換成pdf、word或者是html文檔。

相關(guān)文檔

smart-doc官方wiki：https://gitee.com/smart-doc-team/smart-doc/wikis/Home

Demo

demo地址：https://gitee.com/smart-doc-team/smart-doc-example-cn.git