介紹
smart-doc是一款同時支援JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業内率先提出基于JAVA泛型定義推導的理念，完全基于接口源碼來分析生成接口文檔，不采用任何注解侵入到業務代碼中。
你隻需要按照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參數校驗規範，包括分組驗證。
對JSON請求參數的接口能夠自動生成模拟JSON參數。
對一些常用字段定義能夠生成有效的模拟值。
支援生成JSON傳回值示例。
支援從項目外部加載源代碼來生成字段注釋(包括标準規範釋出的jar包)。
支援生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 開放文檔資料，可自由實作接入文檔管理系統。
支援導出錯誤碼和定義在代碼中的各種字典碼到接口文檔。
支援Maven、Gradle插件式輕松內建。
支援Apache Dubbo RPC接口文檔生成。
debug接口調試html5頁面完全支援檔案上傳，下載下傳(@download tag标記下載下傳方法)測試。
Smart-doc 從 2.0.0 後幾乎實作了 swagger ui 的功能，并且比 swagger ui 更簡潔大方，也更符合國内開發者的訴求。
當然 smart-doc 本身是隻支援掃描代碼生成 openapi 3.0 的文檔的，也可以将生成的 openapi 3.0 文檔導入到其他ui中渲染展示。
效果示例
1.1 接口文檔效果圖
輸入圖檔說明
請求參數示例
響應參數示例
1.2 html全局效果