介紹
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全局效果
更多瞭解，開源地址：https://gitee.com/smart-doc-team
近期熱文推薦：
1.1,000+ 道 Java面試題及答案整理(2021最新版)
2.別在再滿屏的 if/ else 了，試試策略模式，真香！！
3.臥槽！Java 中的 xx ≠ null 是什麼新語法？
4.Spring Boot 2.5 重磅發佈，黑暗模式太炸了！
覺得不錯，別忘了隨手點贊+轉發哦！