内容简介：smart-doc是一个java restful api文档生成工具， smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要写上java的标准注释，smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDo...
smart-doc是一个java restful api文档生成工具， smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要写上 java 的标准注释，smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他 工具 强侵入的注解污染，smart-doc给你一个不错的选择！喜欢smart-doc的用户也不要忘记给项目star，你们的支持是smart-doc持续推进的动力。
功能特性
- 零注解、零学习成本、只需要写标准java注释。
- 基于源代码接口定义自动推导，强大的返回结构推导。
- 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
- 支持Callable,Future,CompletableFuture等异步接口返回的推导。
- 支持JavaBean上的JSR303参数校验规范，支持分组验证。
- 对json请求参数的接口能够自动生成模拟json参数。
- 对一些常用字段定义能够生成有效的模拟值。
- 支持生成json返回值示例。
- 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
- 支持生成多种格式文档：Markdown、HTML5、Asciidoctor、Postman collection。
- 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
- 开放文档数据，可自由实现接入文档管理系统。
- 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。
- 插件式快速集成
Smart-doc vs Swagger
- smart-doc不是对Swagger造轮子，这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单，可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解。
更新内容
- maven插件错误码列表导出bug[git #I1EHXA](https://gitee.com/sunyurepository/smart-doc/issues/I1EHXA)。
- 增加@PatchMapping支持[gitee #I1EDRF](https://gitee.com/sunyurepository/smart-doc/issues/I1EDRF)
- 解决javadoc包含重复tag生成文档报错[gitee #I1ENNM](https://gitee.com/sunyurepository/smart-doc/issues/I1ENNM)。
- 修改当请求参数为泛型时数据解析错误问题。
- 修复分组验证空指针问题，不对返回对象做分组验证处理。
- 优化smart-doc-maven-plugin对多级maven项目的加载。
- 支持请求参数对象替换成另外的对象来渲染文档【很重要的功能】
maven插件
从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin，推荐使用最新版本的插件。当然官方的gradle插件已经开发完毕，
gradle插件目前在测试阶段，使用gradle的用户可以先拉取gradle插件源码自行编译使用等待后续测试完发布。
升级建议
本次发布修改了smart-doc 1.8.0逻辑重构后的用户在使用中发现的bug，建议平滑升级到最新版本。
DEMO
使用demo轻松玩转接口文档生成
知名用户
- 科大讯飞
- 一加
- 小米
相关文档
以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，也希望大家多多支持 码农网
猜你喜欢:
- 无需额外注解的 Spring Boot API 文档生成工具
- Java 注解预处理 Annotation Processing & 代码生成
- JApiDocs 1.3 发布，无需额外注解的 SpringBoot API 文档生成工具
- smart-doc 1.0 发布，Java 零注解文档生成工具
- java 零注解文档生成工具 smart-doc 1.1 发布
- Java 零注解文档生成工具 smart-doc 1.2 发布
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
