介紹

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 重磅釋出，黑暗模式太炸了！

5.《Java開發手冊（嵩山版）》最新發布，速速下載！

覺得不錯，別忘了隨手點贊+轉發哦！