一款零注解侵入的 API 文檔生成工具，你用過嗎？
點擊關注公眾號，Java干貨及時送達
介紹
smart-doc是一款同時支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業(yè)內率先提出基于JAVA泛型定義推導的理念，完全基于接口源碼來分析生成接口文檔，不采用任何注解侵入到業(yè)務代碼中。
你只需要按照java-doc標準編寫注釋， smart-doc就能幫你生成一個簡易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文檔。
特點
零注解、零學習成本、只需要寫標準JAVA注釋。 基于源代碼接口定義自動推導，強大的返回結構推導。 支持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。Up- 開放文檔數(shù)據(jù)，可自由實現(xiàn)接入文檔管理系統(tǒng)。 支持導出錯誤碼和定義在代碼中的各種字典碼到接口文檔。 支持Maven、Gradle插件式輕松集成。 支持Apache Dubbo RPC接口文檔生成。 debug接口調試html5頁面完全支持文件上傳，下載(@download tag標記下載方法)測試。
Smart-doc 從 2.0.0 后幾乎實現(xiàn)了 swagger ui 的功能，并且比 swagger ui 更簡潔大方，也更符合國內開發(fā)者的訴求。
當然 smart-doc 本身是只支持掃描代碼生成 openapi 3.0 的文檔的，也可以將生成的 openapi 3.0 文檔導入到其他ui中渲染展示。
效果示例
1.1 接口文檔效果圖
1.2 html全局效果
更多了解，開源地址：https://gitee.com/smart-doc-team
推薦閱讀： 推薦7個牛哄哄 Spring Cloud 實戰(zhàn)項目 基于 SpringBoot + Vue 框架開發(fā)的網頁版聊天室項目 基于 SpringBoot + Vue 實現(xiàn)的可視化拖拽編輯的大屏項目 Github上10個超好看 可視化面板，后臺管理頁面有著落了 這可能是史上功能最全的Java權限認證框架！ 最近面試BAT，整理一份面試資料《Java面試BAT通關手冊》，覆蓋了Java核心技術、JVM、Java并發(fā)、SSM、微服務、數(shù)據(jù)庫、數(shù)據(jù)結構等等。 獲取方式：關注公眾號并回復 java 領取，更多內容陸續(xù)奉上。 明天見(??ω??)??
評論
圖片
表情