Java面试笔试面经、Java技术每天学习一点
介绍
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念,完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。
你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman、Collection2.0+、OpenAPI 3.0+的文档。
目前使用者
科大讯飞
小米
一加
顺丰
特点
零注解、零学习成本、只需要写标准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。Up- 开放文档数据,可自由实现接入文档管理系统。
支持导出错误码和定义在代码中的各种字典码到接口文档。
支持Maven、Gradle插件式轻松集成。
支持Apache Dubbo RPC接口文档生成。
debug接口调试html5页面完全支持文件上传,下载(@download tag标记下载方法)测试。
Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能,并且比 swagger ui 更简洁大方,也更符合国内开发者的诉求。
当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的,也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。
效果示例
1.1 接口文档效果图
![1.png 54bf6491948cbd36e1d5b3108cac6e9c.png](https://i-blog.csdnimg.cn/blog_migrate/5b1ab7228b439be5dc4fc80b2393f374.png)
![1.png e3ac1af9069f5e71725462b50aeb5cf6.png](https://i-blog.csdnimg.cn/blog_migrate/da053c2ae46c4451525189fd54d7470c.png)
![1.png c92e94ded2d13c8a56bf369d0e8c5461.png](https://i-blog.csdnimg.cn/blog_migrate/053e609388480a361727e09da07f213f.png)
1.2 html全局效果
![example.png 18af94ecf331e2a5058dc422f35f23d5.png](https://i-blog.csdnimg.cn/blog_migrate/b6eb27d5f285c3ece9ad7ec1872456fd.png)
更多了解,开源地址:https://gitee.com/smart-doc-team