天天看點

一款零注解API接口文檔生成工具

smart-doc是一款同時支援JAVA REST API和Apache Dubbo RPC接口文檔生成的工具,基于接口源碼來分析生成接口文檔,不采用任何注解侵入到業務代碼中。隻需要按照java-doc标準編寫注釋,smart-doc就能幫你生成一個簡易明了的Markdown,或是一個像GitBook樣式的靜态html文檔、以及Postman Collection2.0+、OpenAPI 3.0+的文檔。

一款零注解API接口文檔生成工具

一改傳統類似swagger這種大量采用注解侵入來生成文檔的實作方法。

支援接口Debug。

零注解、零學習成本、隻需要寫标準JAVA注釋。

基于源代碼接口定義自動推導,強大的傳回結構推導。

支援Spring MVC、Spring Boot、Spring Boot Web Flux(controller書寫方式)、Feign。

支援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從2.0.0後幾乎實作了swagger ui的功能,并且比swagger ui更簡潔大方,也更符合國内開發者的訴求。當然smart-doc的功能也已經 超過了Swagger為Java開發者提供的功能。

Maven插件形式

一款零注解API接口文檔生成工具

Gradle插件形式

一款零注解API接口文檔生成工具
一款零注解API接口文檔生成工具
一款零注解API接口文檔生成工具
一款零注解API接口文檔生成工具
一款零注解API接口文檔生成工具
一款零注解API接口文檔生成工具