smart-doc 是一款同時支持 JAVA REST API 和 Apache Dubbo RPC 接口文檔生成的工具，基於接口源碼來分析生成接口文檔，不採用任何註解侵入到業務代碼中。只需要按照 java-doc 標準編寫註釋，smart-doc 就能幫你生成一個簡易明瞭的 Markdown，或是一個像 GitBook 樣式的靜態 html 文檔、以及 Postman Collection2.0+、OpenAPI 3.0 + 的文檔。

一改傳統類似 swagger 這種大量採用註解侵入來生成文檔的實現方法。

主要功能特性

• 支持接口 Debug。

• 零註解、零學習成本、只需要寫標準 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、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 開發者提供的功能。

使用形式

• Maven 插件形式

• Gradle 插件形式

使用效果

源碼和文檔地址

源碼，具體詳細使用方式以及 Demo 可參考：https://gitee.com/smart-doc-team/smart-doc

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/ZW2qd-qxlkS8LDk_kerVuQ