smart-doc 2.0.1 發布,Java 零註解 API 文檔生成工具

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 和其他工具的支持

功能特性	smart-doc	swagger
代碼侵入	無	註解侵入性嚴重
集成複雜度	簡單，只需插件	偏複雜
插件支持	有gradle和maven插件	無插件
openapi規範支持	支持openapi 3.0	完全支持openapi的版本
CI構建集成	可在ci構建階段使用 maven或者gradle命令 啟動插件生成文檔	不支持
集中化文檔中心集成	未來會獨家支持集成 神秘的集中化文檔管理中心， 打造自動、一體化的企業級接口文檔解決方案	不支持
維護持續性	值得信賴，開源後用戶基礎多，一直持續維護	全球用戶多，開源維護值得信賴
接口debug	2.0.0版本開始已經支持debug	支持

Smart-doc 從2.0.0後幾乎實現了swagger ui的功能，並且比swagger ui更簡潔大方，也更符合國內開發者的訴求。當然smart-doc的功能也已經

超過了swagger為java開發者提供的功能。

更新內容

從2.0.0版本開始，smart-doc完全支持生成debug調試頁面。從本次發布的2.0.1版本起，smart-doc的生成的debug頁面完全支持文件的上傳下載測試。

1. debug調試頁面支持文件上傳。2. 修改簡單請求參數mock值和類型不匹配問題。3. debug頁面完全支持文件下載測試。4. 所有html的文檔支持接口目錄搜索。5. 剔除flexmark依賴，舊的非allInOne模板刪除，統一h5文檔樣式。

debug頁面效果

maven或gradle插件

smart-doc官方為了方便用戶快速和無侵入的集成smart-doc的文檔api生成能力，我們開發可相關的maven或者gradle插件。這裡也推薦使用插件的方式來使用smart-doc。

https://gitee.com/smart-doc-team/smart-doc-maven-plugin

升級建議

 建議使用使用smart-doc或者smart-doc-maven-plugin、smart-doc-gradle-plugin開源組件1.x版本的升級到2.0.0 。2.x後debug頁面的支持，可以方便後端開發者自行調試接口。

DEMO

使用demo輕鬆玩轉接口文檔生成，其他用戶案例文檔效果展示：https://api.doubans.com/

知名用戶