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插件形式

使用效果

源码和文档地址

源码，具体详细使用方式以及Demo可参考：https://gitee.com/smart-doc-team/smart-doc

有道无术，术可成；有术无道，止于术

欢迎大家关注Java之道公众号

好文章，我在看❤️

一款零注解API接口文档生成工具相关推荐

扔掉Swagger，试试这款功能强大，零注解侵入的API接口文档生成工具！
欢迎关注方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...
一款强大的API接口文档管理工具（Smart-Doc + Torna）
[本文由龙飞同学供稿] 在团队协作开发项目的时候,接口文档承担着向其他开发人员说明接口相关信息的重要任务,因此,一份清晰而又相近的接口文档至关重要. 但是,写接口文档的痛苦想必各位开发人员都体验过,明 ...
盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
spring-boot 一款无侵入型，轻量级的接口文档生成工具apiggs
spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs 名字叫:apiggs 使用只需两步,先把插件代码引入pom文件,然后编译打包即可之后项目的target目录下,就会多出一个 ...
java接口文档生成工具_【分享】接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...
java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流 ...
java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释接口字段变动,还得去更新文档,更新不及时导致文档不同步或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...

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

主要功能特性

使用形式

使用效果

源码和文档地址

一款零注解API接口文档生成工具相关推荐

最新文章

热门文章