Java Restful Api零注解多格式文档生成工具

之前对OPENAPI做了简单的介绍,大家喜欢的话可以再去看看。

前后端分离下有哪些好用的OPENAPI管理系统:
http://www.chanpindashi.com/2020/02/29/3208.html

产品经理OpenAPI开放平台设计思路解析,OpenAPI开放平台竞品网站有哪些:
http://www.chanpindashi.com/2019/11/29/1958.html

今天介绍Java Restful Api零注解多格式文档生成工具

smart-doc介绍

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman json一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个不错的选择!喜欢smart-doc的用户也不要忘记给项目star,你们的支持是smart-doc持续推进的动力。

功能特性

1.零注解、零学习成本、只需要写标准java注释。

2.基于源代码接口定义自动推导,强大的返回结构推导。

3.支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。

4.支持Callable,Future,CompletableFuture等异步接口返回的推导。

5.支持JavaBean上的JSR303参数校验规范。

6.对json请求参数的接口能够自动生成模拟json参数。

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

8.支持生成json返回值示例。

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

10.支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman json。

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

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

13.一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。

对比Swagger

1.smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。

2.smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。

3.smart-doc完全不需要在侵入到业务代码中写任何注解。

知名用户

⊙科大讯飞

⊙小米

⊙一加手机

效果图

smart-doc支持生成markdown、html、adoc、postman json。smart-doc 1.7.9后可以使用smart-doc-maven-plugin来生成文档,无需再使用单元测试来启动smart-doc生成文档。下面文档仅适用于在项目中依赖smart-doc,如果单纯使用smart-doc-maven-plugin插件单元测试会报错。

相关文档

smart-doc文档wiki

https://gitee.com/sunyurepository/smart-doc/wikis/Home

分享不易,请支持本站其他资源

新版axureshop产品原型网:http://www.axureshops.com
AxureShop商城:http://axure.amynik.com/
情趣商城:http://sex.chanpindashi.com/
Axure工具集下载:http://www.chanpindashi.com/2019/12/02/1997.html
产品大师:http://www.chanpindashi.com/
源码商城:http://mall.amynik.com/list/1
axureshop产品原型网(旧版停止更新):http://axureshop.amynik.com/
产品经理论坛:http://bbs.amynik.com
淘宝优惠券:http://taobao.chanpindashi.com/
京东优惠券:http://jd.chanpindashi.com/?chanpindashi.com

最后编辑:2020年03月06日 ©著作权归作者所有

发表评论

×