介紹
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開發手冊（嵩山版）》最新發布，速速下載！
覺得不錯，別忘了隨手點贊+轉發哦！
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/331953.html
標籤：Java