介紹

smart-doc是一款同時(shí)支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業(yè)內(nèi)率先提出基于JAVA泛型定義推導(dǎo)的理念，完全基于接口源碼來分析生成接口文檔，不采用任何注解侵入到業(yè)務(wù)代碼中。

你只需要按照java-doc標(biāo)準(zhǔn)編寫注釋， smart-doc就能幫你生成一個(gè)簡易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文檔。

目前使用者

• 科大訊飛

• 小米

• 一加

• 順豐

特點(diǎn)

• 零注解、零學(xué)習(xí)成本、只需要寫標(biāo)準(zhǔn)JAVA注釋。
• 基于源代碼接口定義自動推導(dǎo)，強(qiáng)大的返回結(jié)構(gòu)推導(dǎo)。
• 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller書寫方式)、Feign。
• 支持Callable、Future、CompletableFuture等異步接口返回的推導(dǎo)。
• 支持JavaBean上的JSR303參數(shù)校驗(yàn)規(guī)范，包括分組驗(yàn)證。
• 對JSON請求參數(shù)的接口能夠自動生成模擬JSON參數(shù)。
• 對一些常用字段定義能夠生成有效的模擬值。
• 支持生成JSON返回值示例。
• 支持從項(xiàng)目外部加載源代碼來生成字段注釋(包括標(biāo)準(zhǔn)規(guī)范發(fā)布的jar包)。
• 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 開放文檔數(shù)據(jù)，可自由實(shí)現(xiàn)接入文檔管理系統(tǒng)。
• 支持導(dǎo)出錯誤碼和定義在代碼中的各種字典碼到接口文檔。
• 支持Maven、Gradle插件式輕松集成。
• 支持Apache Dubbo RPC接口文檔生成。
• debug接口調(diào)試html5頁面完全支持文件上傳，下載(@download tag標(biāo)記下載方法)測試。

Smart-doc 從 2.0.0 后幾乎實(shí)現(xiàn)了 swagger ui 的功能，并且比 swagger ui 更簡潔大方，也更符合國內(nèi)開發(fā)者的訴求。

當(dāng)然 smart-doc 本身是只支持掃描代碼生成 openapi 3.0 的文檔的，也可以將生成的 openapi 3.0 文檔導(dǎo)入到其他ui中渲染展示。

學(xué)習(xí)資料：Java進(jìn)階視頻資源

效果示例

1.1 接口文檔效果圖

1.2 html全局效果

更多了解，開源地址：https://gitee.com/smart-doc-team

- END -
最近熱文
?  程序員之天梯排行榜，你在哪一級？
?  知乎熱議：國家何時(shí)整治程序員的高薪現(xiàn)象 ？網(wǎng)友：用命和頭發(fā)換的錢都被眼紅？！
?  CTO怒了：“如果中臺不省錢，我建個(gè)屁中臺啊！”
?  上海有哪些牛逼的互聯(lián)網(wǎng)公司？
?  你偷看的小黃片，全被監(jiān)視了