支持Dubbo接口文档生成的工具!
点击上方蓝色“程序猿DD”,选择“设为星标”
回复“资源”获取独家整理的学习资料!
作者 | 肥朝
来源 | https://mp.weixin.qq.com/s/JW0yPtaIeyYZCs2PuucICQ
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
推荐关注这个励志推荐10000个开源项目的兄弟
每天了解一个开源工具转入你的兵器库
【往期推荐】
36 张图梳理 Intellij IDEA 常用设置
2020-12-23
13个Mongodb GUI可视化管理工具,总有一款适合你
2020-12-23
小宇宙爆发!Spring Boot 新特性:节省95%内存占用
2020-12-22
超级干货:你应该知道的那些编程原则!!
2020-12-22
不敢相信,居然用Java写了个“天天酷跑”!
2020-12-21
素质二连,走一个
支持Dubbo接口文档生成的工具!相关推荐
- 扔掉Swagger,试试这款功能强大,零注解侵入的API接口文档生成工具!
欢迎关注方志朋的博客,回复"666"获面试宝典 介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...
- 一款零注解API接口文档生成工具
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中.只需要按照java-do ...
- spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs
spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs 名字叫:apiggs 使用只需两步,先把插件代码引入pom文件,然后编译打包即可 之后项目的target目录下,就会多出一个 ...
- java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
- java接口文档生成工具_【分享】接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...
- 接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流 ...
- 基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世 现在大多数项目都走向了前后端分离 ...
- 转帖“接口测试工具和接口文档生成”
最近在研究接口测试,然后在网上找工具来进行接口测试.现在主流使用的接口测试工具一般有:jmeter.postman.soapui.apipost jmeter可以进行接口测试和性能测试,但是对于做单纯 ...
- Swagger自动接口文档生成框架————springboot整合swagger总结
swagger简介: swagger是一款开源的api接口文档生成工具. Swagger的项目主页:https://swagger.io/ 目前比较流行的做法是在代码中加入swagger相关的注 ...
最新文章
- FPP(彩包)、COEM(简包)、MOLP(license授) 介绍
- USTC English Club Note20171023(2)
- 计算机图形学画圆和直线代码,计算机图形学作业(中点法画直线和八分画圆法).doc...
- 关于我对于写博客写文章的理解
- python四大高阶函数_四大高阶函数
- c语言迷宫源码,C语言迷宫源代码
- [Swift]LeetCode1051.高度检查器 | Height Checker
- 安装卸载gitlab
- Oracle中“行转列”的实现方式
- android 支付宝接口开发,android 实现支付宝wap接口编程
- GDI函数 StretchDIBits,StretchBlt 缩小图片会有黑点的问题解决办法
- com词根词缀_英语词根词缀,cor和con分别代表什么意思
- Java @link 注释
- 《zw版·Halcon-delphi系列原创教程》 Halcon分类函数001·3D函数
- 游密科技携手华为云,探讨5G时代下音视频领域的创新变革
- python wms系统源码_jeewms仓库管理系统 v2.4.0
- 高德地图实现逻辑及代码
- PPT2010中,如何让带圈的序号填充背景颜色?
- 通证估值模型-费雪模型与净现值模型详解
- k8s指定node调度