共计 1113 个字符，预计需要花费 3 分钟才能阅读完成。
介绍
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.2 html 全局成果
更多理解，开源地址：https://gitee.com/smart-doc-team
近期热文举荐：
1.1,000+ 道 Java 面试题及答案整顿(2021 最新版)
2. 别在再满屏的 if/ else 了，试试策略模式，真香！！
3. 卧槽！Java 中的 xx ≠ null 是什么新语法？
4.Spring Boot 2.5 重磅公布，光明模式太炸了！
5.《Java 开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞 + 转发哦！