歡迎您光臨本站 註冊首頁

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

←手機掃碼閱讀     admin @ 2020-01-03 , reply:0

smart-doc是一個java restful api文檔生成工具, smart-doc完全基於介面源碼分析來生成介面文檔,完全做到零註解侵入,你只需要寫上java的標準註釋,smart-doc就能幫你生成一個簡易明了的Markdown、Html、AsciiDoc文檔和Postman json一鍵導入的測試數據。如果你不喜歡其他工具強侵入的註解污染,smart-doc給你一個不錯的選擇!喜歡smart-doc的用戶也不要忘記給項目star,你們的支持是smart-doc持續推進的動力。

功能特性

  • 零註解、零學習成本、只需要寫標準java註釋。
  • 基於源代碼介面定義自動推導,強大的返回結構推導。
  • 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller書寫方式)。
  • 支持Callable,Future,CompletableFuture等非同步介面返回的推導。
  • 支持JavaBean上的JSR303參數校驗規範。
  • 對json請求參數的介面能夠自動生成模擬json參數。
  • 對一些常用欄位定義能夠生成有效的模擬值。
  • 支持生成json返回值示例。
  • 支持從項目外部載入源代碼來生成欄位註釋(包括標準規範發布的jar包)。
  • 支持生成多種格式文檔:Markdown、HTML5、Asciidoctor、Postman json。
  • 輕易實現在Spring Boot服務上在線查看靜態HTML5 api文檔。
  • 開放文檔數據,可自由實現接入文檔管理系統。
  • 一款代碼註釋檢測工具,不寫註釋的小夥伴逃不過法眼了。

Smart-doc vs Swagger

  •  smart-doc不是對Swagger造輪子,這是一款用完全不同的理念重新開發的restful api介面文檔生成工具。
  •  smart-doc比swagger集成更簡單,可以自由生成多種格式的api文檔。
  •  smart-doc完全不需要在侵入到業務代碼中寫任何註解。

更新內容

1. 響應用戶需求,對spring的表單參數綁定做了全面的支持,smart-doc不再是僅僅支持json參數。
2. 合併fork分支的github book html5模板,新增搜索和錨點。
3. 新增自定義@mock tag用於指定生成文檔時的默認欄位值,@param 的參數註釋增加mock值的解析功能(@param name 姓名|張三),
   此項改進可以滿足用戶直接使用smart-doc生成交付給第三方公司的對接文檔。
4. smart-doc-maven-plugin插件增強對maven標準項目的支持(插件仍然存在一些問題,當前未找到解決辦法)。
5. 對生成的postman json數據做了全面的增強,無論是json還是表單參數,導出的postman json可以一鍵導入postman自動完成參數列表回填。
6. 優化對實體類中枚舉欄位的支持。
7. 增加對實體中靜態常量常量欄位的過濾。

maven插件

從smart-doc 1.7.9版本開始。我們提供了smart-doc的插件smart-doc-maven-plugin,目前該插件只做試用。

插件使用文檔

升級建議

   本次主要是對錶單參數和postman數據導出做了增強。也修改了一起bug和部分源碼做了重構,建議用戶升級到最新。

DEMO

使用demo輕鬆玩轉介面文檔生成

知名用戶

  • 科大訊飛
  • 一加
  • 小米

相關文檔

smart-doc文檔wiki


[admin ]

來源:OsChina
連結:https://www.oschina.net/news/112523/smart-doc-1-8-0-released
smart-doc 1.8.0 發布,Java 零註解文檔生成工具已經有103次圍觀

http://coctec.com/news/all/show-post-222015.html