Introduce
smart-doc是一款同時支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業內率先提出基於JAVA泛型定義推導的理念， 徹底基於接口源碼來分析生成接口文檔，不採用任何註解侵入到業務代碼中。你只須要按照java-doc標準編寫註釋， smart-doc就能幫你生成一個簡易明瞭的Markdown、HTML5文檔，甚至能夠直接生成Postman Collection導入到Postman作API接口調試。html
Features
-
零註解、零學習成本、只須要寫標準JAVA註釋。 -
基於源代碼接口定義自動推導，強大的返回結構推導。 -
支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller書寫方式)、Feign。 -
支持Callable、Future、CompletableFuture等異步接口返回的推導。 -
支持JavaBean上的JSR303參數校驗規範，包括分組驗證。 -
對JSON請求參數的接口可以自動生成模擬JSON參數。 -
對一些經常使用字段定義可以生成有效的模擬值。 -
支持生成JSON返回值示例。 -
支持從項目外部加載源代碼來生成字段註釋(包括標準規範發佈的jar包)。 -
支持生成多種格式文檔：Markdown、HTML五、Asciidoctor、Postman Collection、OpenAPI 3.0。 -
輕易實如今Spring Boot服務上在線查看靜態HTML5 api文檔。 -
開放文檔數據，可自由實現接入文檔管理系統。 -
支持導出錯誤碼和定義在代碼中的各類字典碼到接口文檔。 -
支持Maven、Gradle插件式輕鬆集成。 -
支持Apache Dubbo RPC接口文檔生成。
Smart-doc生成文檔效圖
接口頭部效果圖
請求參數示例效果圖
請求參數示例java
響應參數示例效果圖
響應參數示例git
html文檔效果圖
html文檔web
項目地址
開源地址：https://gitee.com/smart-doc-team/smart-docapi
本文分享自微信公衆號 - 肥朝（feichao_java）。
若有侵權，請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」，歡迎正在閱讀的你也加入，一塊兒分享。微信