支持Dubbo接口文档生成的工具!
路人甲Java
共 1581字,需浏览 4分钟
· 2021-03-01
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生成文档效图
接口头部效果图
请求参数示例效果图
请求参数示例
响应参数示例效果图
响应参数示例
html文档效果图
html文档
项目地址
开源地址:https://gitee.com/smart-doc-team/smart-doc
作者 | 肥朝
重磅!程序员交流群(无广告)已成立
在群里和大家分享一些程序员开发相关的知识,包括部分自己的实战项目,基础入门知识,spring,jvm,mysql等等。也会免费分享一些Java视频教程、电子资料、Mysql资料、Kubernetes及最新Java面试资料。
同时为了帮助到其他技术栈 小伙伴,我也准备了一些Python,前端,Linux,C语言等其他技术资料!
有兴趣入群的同学,可长按扫描下方二维码添加微信
一定要备注:Java,可更快被通过且邀请进群
评论
接口文档生成工具
一、为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。 2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流开...
测试人生路
0
Evalon4JJava 接口文档生成工具
Evalon4J是一个Java接口文档生成工具,直接通过命令行使用,支持Spring-MVC,JAX-RS,Swagger2.0等多种框架注解。同时它是付费产品 RabiAPI 使用的底层框架,通过静
Evalon4JJava 接口文档生成工具
0
swagger接口文档生成工具
文章首推支付宝接口对接高德地图调用验证码登录QQ邮箱登录今日主题:swagger接口文档生成工具简介在一个大的的项目中可能会有很多控制类,每个控制类中会有很多方法,这时候我们需要一个接口文档生成工具来暴露这些接...
java宝典
0
Apidoc-phpAPI 接口文档生成工具
Apidoc是一个通过解析注解生成API接口文档的PHPcomposer扩展,支持在线调试、Mock数据、Md文档等功能。 全面的注解引用、数据表字段引用,简单的注解即可生成Api文档,而Apidoc
Apidoc-phpAPI 接口文档生成工具
0
swammdoc接口文档自动生成工具
swammdoc接口文档自动生成工具如图: 团队协作离不开约定,规范,最早我们用word,excel编写接口文档,现在有了开源,涌现了一批接口文档管理平台,rap,小幺鸡,apiManager等等,有
swammdoc接口文档自动生成工具
0