支持Dubbo接口文档生成的工具

点击上方 Java后端&＃xff0c;选择 设为星标

优质文章&＃xff0c;及时送达

Introduce

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具&＃xff0c;smart-doc在业内率先提出基于JAVA泛型定义推导的理念&＃xff0c; 完全基于接口源码来分析生成接口文档&＃xff0c;不采用任何注解侵入到业务代码中。

你只需要按照java-doc标准编写注释&＃xff0c; smart-doc就能帮你生成一个简易明了的Markdown、HTML5文档&＃xff0c;甚至可以直接生成Postman Collection导入到Postman做API接口调试。

Features

• 零注解、零学习成本、只需要写标准JAVA注释。

• 基于源代码接口定义自动推导&＃xff0c;强大的返回结构推导。

• 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。

• 支持Callable、Future、CompletableFuture等异步接口返回的推导。

• 支持JavaBean上的JSR303参数校验规范&＃xff0c;包括分组验证。

• 对JSON请求参数的接口能够自动生成模拟JSON参数。

• 对一些常用字段定义能够生成有效的模拟值。

• 支持生成JSON返回值示例。

• 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。

• 支持生成多种格式文档&＃xff1a;Markdown、HTML5、Asciidoctor、Postman Collection、OpenAPI 3.0。

• 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。

• 开放文档数据&＃xff0c;可自由实现接入文档管理系统。

• 支持导出错误码和定义在代码中的各种字典码到接口文档。

• 支持Maven、Gradle插件式轻松集成。

• 支持Apache Dubbo RPC接口文档生成。

Smart-doc生成文档效图

接口头部效果图

请求参数示例效果图

请求参数示例

响应参数示例效果图

响应参数示例

html文档效果图

开源地址&＃xff1a;https://gitee.com/smart-doc-team/smart-doc

Java后端交流群已成立
公众号运营至今&＃xff0c;离不开小伙伴们的支持。为了给小伙伴们提供一个互相交流的平台&＃xff0c;特地开通了官方交流群。扫描下方二维码备注 进群 或者关注公众号 Java后端 后获取进群通道。


推荐阅读 1. MyBatis-Plus常用 API 全套教程2. 如何用手机抓包&＃xff1f;3. 牛逼&＃xff01;Docker从入门到上瘾4. 连夜撸了一个简易聊天室5. 推荐一款 Java 对象映射神器