内容简介：smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档，完...
smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。
smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释编写，smart-doc就能帮你生成一个简易明了的markdown 或是一个像GitBook样式的静态html文档。如果你已经厌倦了swagger等文档 工具 的无数注解和强侵入污染，那请拥抱smart-doc吧！
功能特性
- 支持接口debug。
- 零注解、零学习成本、只需要写标准java注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
- 支持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 和其他工具的支持
| 功能特性 | smart-doc | swagger | 非swagger生态圈工具 |
| 代码侵入 | 无 | 注解侵入性严重 | 部分工具和swagger同理，部分工具也采用源码分析 |
| 集成复杂度 | 简单，只需插件 | 偏复杂 | |
| 插件支持 | 有gradle和maven插件 | 无插件 | 基本无插件 |
| openapi规范支持 | 支持openapi 3.0 | 完全支持openapi的版本 | |
| CI构建集成 |
可在ci构建阶段使用 maven或者gradle命令 启动插件生成文档
|
不支持 | 几乎不支持 |
| 集中化文档中心集成 |
未来会独家支持集成 神秘的集中化文档管理中心， 打造自动、一体化的企业级接口文档解决方案 |
不支持 | 几乎不支持 |
| 维护持续性 | 值得信赖，开源后用户基础多，一直持续维护 | 全球用户多，开源维护值得信赖 | 维护持续性低，停更风险高 |
| 接口debug | 2.0.0版本开始已经支持debug | 支持 | 未知 |
更新内容
新的2.0.0版本，smart-doc带来了大家期待已久的接口调试功能，现在可以使用smart-doc生成一个简洁漂亮的接口调试html5页面了。
1. 优化了文档的显示，将query和path单独提出来做了展示 2. 优化openapi 3.0文档规范的支持，可集成swagger ui等ui使用。 3. 优化postman collection 2.0的支持。 4. 添加分组支持group。 5. 修改mock的一些bug和增强使用 6. 支出创建debug页面
debug页面效果
maven或gradle插件
smart-doc官方为了方便用户快速和无侵入的集成smart-doc的文档api生成能力，我们开发可相关的maven或者gradle插件。这里也推荐使用插件的方式来使用smart-doc。
https://gitee.com/smart-doc-team/smart-doc-maven-plugin
升级建议
这个版本支持生成可以debug的html文档页面了，建议升级，使用单元测试构建文档的用户，此版本涉及到一些使用方法的变更，建议切换到插件去使用。
DEMO
使用demo轻松玩转接口文档生成，其他用户案例文档效果展示：https://api.doubans.com/
知名用户
- 科大讯飞
- 一加
- 小米
以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，也希望大家多多支持 码农网
猜你喜欢:
- imi v1.0.3 发布，重磅推出注解及代码的毫秒级热更新
- smart-doc 1.7.0 重磅发布，Java 零注解文档生成工具
- Spring 注解编程之模式注解
- Java注解之编译时注解
- Java注解之运行时注解
- Java中的注解-自定义注解
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
