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

2年前 (2022) 程序员胖胖胖虎阿
203 0 0

点击上方 Java后端选择 设为星标

优质文章,及时送达


Introduce

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。
你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5文档,甚至可以直接生成Postman Collection导入到Postman做API接口调试。

Features

  • 零注解、零学习成本、只需要写标准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、OpenAPI 3.0。

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

  • 开放文档数据,可自由实现接入文档管理系统。

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

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

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

Smart-doc生成文档效图

接口头部效果图

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

请求参数示例效果图

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

请求参数示例

响应参数示例效果图

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

响应参数示例

html文档效果图

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

开源地址:https://gitee.com/smart-doc-team/smart-doc


   
   
   

Java后端交流群已成立

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

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


    
    
    

读 

1. MyBatis-Plus常用 API 全套教程

2. 如何用手机抓包?

3. 牛逼!Docker从入门到上瘾

4. 连夜撸了一个简易聊天室

5. 推荐一款 Java 对象映射神器

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


本文分享自微信公众号 - Java后端(web_resource)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

版权声明:程序员胖胖胖虎阿 发表于 2022年10月6日 下午7:56。
转载请注明:支持 Dubbo 接口文档生成的工具 | 胖虎的工具箱-编程导航

相关文章

暂无评论

暂无评论...