smart-doc是一款同時支援JAVA REST API和Apache Duadfdso RPC介面文件產生的工具,smart-doc在業界率先提出基於JAVA泛型定義推導的概念, 完全基於介面源碼來分析產生介面文檔,不採用任何註解侵入到業務代碼中。你只需要依照java-doc標準寫註釋, smart-doc就能幫你產生一個簡易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文件。
1、零註解、零學習成本、只需要寫標準JAVA註。
2、基於原始碼介面定義自動推導,強大的返回結構推導。
3.支援Spring MVC、Spring Boot、Spring Boot Web Flux(controller書寫方式)、Feign、JAX-RS。
4、支援Callable、Future、CompletableFuture等非同步介面傳回的推導。
5.支援JavaBean上的JSR303參數校驗規範,包括分組驗證。
6.對JSON請求參數的介面能夠自動產生模擬JSON參數。
7.對一些常用欄位定義能夠產生有效的模擬值。
8.支援產生JSON回傳值範例。
9.支援從專案外部載入原始程式碼來產生字段註解(包括標準規範發布的jar包)。
10.支援產生多種格式文件:Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。 Up- 開放文件數據,可自由實現接入文件管理系統。
11、支援導出錯誤碼和定義在程式碼中的各種字典碼到介面文件。
12.支援Maven、Gradle插件式輕鬆整合。
13.支援Apache Duadfdso RPC介面文件產生。
14.debug介面調試html5頁面完全支援檔案上傳,下載(@download tag標記下載方法)測試。