• 主要功能特性
• 使用形式
• Maven插件形式
• Gradle插件形式
• 使用效果
• 源碼和文檔地址

smart-doc是一款同時(shí)支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，基于接口源碼來分析生成接口文檔，不采用任何注解侵入到業(yè)務(wù)代碼中。只需要按照java-doc標(biāo)準(zhǔn)編寫注釋，smart-doc就能幫你生成一個(gè)簡(jiǎn)易明了的Markdown，或是一個(gè)像GitBook樣式的靜態(tài)html文檔、以及Postman Collection2.0+、OpenAPI 3.0+的文檔。

一改傳統(tǒng)類似swagger這種大量采用注解侵入來生成文檔的實(shí)現(xiàn)方法。

主要功能特性

• 支持接口Debug。
• 零注解、零學(xué)習(xí)成本、只需要寫標(biāo)準(zhǔn)JAVA注釋。
• 基于源代碼接口定義自動(dòng)推導(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)證。
• 對(duì)JSON請(qǐng)求參數(shù)的接口能夠自動(dòng)生成模擬JSON參數(shù)。
• 對(duì)一些常用字段定義能夠生成有效的模擬值。
• 支持生成JSON返回值示例。
• 支持從項(xiàng)目外部加載源代碼來生成字段注釋(包括標(biāo)準(zhǔn)規(guī)范發(fā)布的 jar 包)。
• 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman collection、Open Api 3.0+。
• 輕易實(shí)現(xiàn)在 Spring Boot 服務(wù)上在線查看靜態(tài) HTML5 api 文檔。
• 支持Maven、Gradle插件式輕松集成。
• 支持 Apache Dubbo rpc 文檔生成。

smart-doc從2.0.0后幾乎實(shí)現(xiàn)了swagger ui的功能，并且比swagger ui更簡(jiǎn)潔大方，也更符合國(guó)內(nèi)開發(fā)者的訴求。當(dāng)然smart-doc的功能也已經(jīng) 超過了Swagger為Java開發(fā)者提供的功能。

使用形式

Maven插件形式

Gradle插件形式

使用效果

推薦資源
歡迎添加程序汪個(gè)人微信 itwang007  進(jìn)粉絲群或圍觀朋友圈
往期資源  需要請(qǐng)自取
Java項(xiàng)目分享 最新整理全集，找項(xiàng)目不累啦 03版
臥槽！字節(jié)跳動(dòng)《算法中文手冊(cè)》火了，完整版 PDF 開放下載！
字節(jié)跳動(dòng)總結(jié)的設(shè)計(jì)模式 PDF 火了，完整版開放下載！
堪稱神級(jí)的Spring Boot手冊(cè)，從基礎(chǔ)入門到實(shí)戰(zhàn)進(jìn)階
臥槽！阿里大佬總結(jié)的《圖解Java》火了，完整版PDF開放下載！
喜歡就"在看"唄^_^