一款零注解侵入的 API 文檔生成工具，你用過(guò)嗎？
點(diǎn)擊關(guān)注公眾號(hào)，Java干貨及時(shí)送達(dá)
真香！24W字的Java面試手冊(cè)（點(diǎn)擊查看）
介紹
smart-doc是一款同時(shí)支持JAVA REST API和Apache Dubbo RPC接口文檔生成的工具，smart-doc在業(yè)內(nèi)率先提出基于JAVA泛型定義推導(dǎo)的理念，完全基于接口源碼來(lái)分析生成接口文檔，不采用任何注解侵入到業(yè)務(wù)代碼中。
你只需要按照java-doc標(biāo)準(zhǔn)編寫(xiě)注釋?zhuān)?smart-doc就能幫你生成一個(gè)簡(jiǎn)易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文檔。
特點(diǎn)
零注解、零學(xué)習(xí)成本、只需要寫(xiě)標(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書(shū)寫(xiě)方式)、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)目外部加載源代碼來(lái)生成字段注釋(包括標(biāo)準(zhǔn)規(guī)范發(fā)布的jar包)。 支持生成多種格式文檔：Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。Up- 開(kāi)放文檔數(shù)據(jù)，可自由實(shí)現(xiàn)接入文檔管理系統(tǒng)。 支持導(dǎo)出錯(cuò)誤碼和定義在代碼中的各種字典碼到接口文檔。 支持Maven、Gradle插件式輕松集成。 支持Apache Dubbo RPC接口文檔生成。 debug接口調(diào)試html5頁(yè)面完全支持文件上傳，下載(@download tag標(biāo)記下載方法)測(cè)試。
當(dāng)然 smart-doc 本身是只支持掃描代碼生成 openapi 3.0 的文檔的，也可以將生成的 openapi 3.0 文檔導(dǎo)入到其他ui中渲染展示。
效果示例
1.1 接口文檔效果圖
1.2 html全局效果
更多了解，開(kāi)源地址：https://gitee.com/smart-doc-team
如有文章對(duì)你有幫助，
歡迎關(guān)注??、點(diǎn)贊??、轉(zhuǎn)發(fā)??！
推薦， Java面試手冊(cè) 內(nèi)容包括網(wǎng)絡(luò)協(xié)議、Java基礎(chǔ)、進(jìn)階、字符串、集合、并發(fā)、JVM、數(shù)據(jù)結(jié)構(gòu)、算法、MySQL、Redis、Mongo、Spring、SpringBoot、MyBatis、SpringCloud、Linux以及各種中間件（Dubbo、Nginx、Zookeeper、MQ、Kafka、ElasticSearch）等等... 點(diǎn)擊文末“閱讀原文”可直達(dá)
評(píng)論
圖片
表情