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

我是程序汪

共 1237字,需浏览 3分钟

 ·

2021-07-17 14:51


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

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。只需要按照java-doc标准编写注释,smart-doc就能帮你生成一个简易明了的Markdown,或是一个像GitBook样式的静态html文档、以及Postman Collection2.0+、OpenAPI 3.0+的文档。

图片

一改传统类似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插件形式

图片

Gradle插件形式

图片

使用效果

图片
图片
图片
图片

推荐资源

欢迎添加程序汪个人微信 itwang007  进粉丝群或围观朋友圈

往期资源  需要请自取

Java项目分享 最新整理全集,找项目不累啦 03版

卧槽!字节跳动《算法中文手册》火了,完整版 PDF 开放下载

字节跳动总结的设计模式 PDF 火了,完整版开放下载!

堪称神级的Spring Boot手册,从基础入门到实战进阶

卧槽!阿里大佬总结的《图解Java》火了,完整版PDF开放下载!

喜欢就"在看"呗^_^

浏览 13
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报