smart-doc 是一款同時支援 java restful api 和 Apache Dubbo rpc 介面文件生成的工具,smart-doc 顛覆了傳統類似 swagger 這種大量採用註解侵入來生成文件的實現方法。
smart-doc 完全基於介面原始碼分析來生成介面文件,完全做到零註解侵入,你只需要按照 java 標準註釋編寫,smart-doc 就能幫你生成一個簡易明瞭的 markdown 或是一個像 GitBook 樣式的靜態 html 文件。如果你已經厭倦了 swagger 等文件工具的無數註解和強侵入汙染,那請擁抱 smart-doc 吧!
功能特性
支援介面 debug。
零註解、零學習成本、只需要寫標準 java 註釋。
基於原始碼介面定義自動推導,強大的返回結構推導。
支援 Spring MVC,Spring Boot,Spring Boot Web Flux(controller 書寫方式)。
支援 Callable,Future,CompletableFuture 等非同步介面返回的推導。
支援 JavaBean 上的 JSR303 引數校驗規範,支援分組驗證。
對 json 請求引數的介面能夠自動生成模擬 json 引數。
對一些常用欄位定義能夠生成有效的模擬值。
支援生成 json 返回值示例。
支援從專案外部載入原始碼來生成欄位註釋(包括標準規範釋出的 jar 包)。
支援生成多種格式文件:Markdown、HTML5、Asciidoctor、Postman collection、Open Api 3。0+。
輕易實現在 Spring Boot 服務上線上檢視靜態 HTML5 api 文件。
開放文件資料,可自由實現接入文件管理系統。
一款程式碼註釋檢測工具,不寫註釋的小夥伴逃不過法眼了。
外掛式快速整合(支援 maven 和 gradle 外掛)。
支援 Apache Dubbo rpc 文件生成。
Smart-doc 從 2。0。0 後幾乎實現了 swagger ui 的功能,並且比 swagger ui 更簡潔大方,也更符合國內開發者的訴求。當然 smart-doc 的功能也已經
超過了 swagger 為 java 開發者提供的功能。當然 smart-doc 本身是隻支援掃描程式碼生成 openapi 3。0 的文件的,也可以將生成的 openapi 3。0 文件匯入到其他ui中渲染展示。
效果圖
原始碼:https://gitee。com/smart-doc-team