内容简介: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吧!
功能特性
- 零注解、零学习成本、只需要写标准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 vs Swagger
- smart-doc不是对Swagger造轮子,这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
- smart-doc比swagger集成更简单,可以自由生成多种格式的api文档。
- smart-doc完全不需要在侵入到业务代码中写任何注解,插件化集成到项目。
- smart-doc提供了许多swagger没有 的功能,例如:字典码、业务错误码导出到文档,dubbo rpc接口文档生成。
- smart-doc完全支持swagger指定的标准open api 3.0+规范。
- smart-doc对于企业来说提供了比swagger更多的扩拓展能力,例如用smart-doc开放的数据自己开发生成性能测试脚本等。
更新内容
1. 修复restful接口泛型中使用?时的解析错误。
2. 优化rpc html非all in one的问题。
3. 对rest query参数自动添加描述,增加可读性。
4. 增加对原阿里巴巴dubbo版本的支持 .
5. 支持对@RequestMapping headers的解析.
6. 优化gradle插件的源码加载,去除非必要源码加载,根据模块依赖智能加载源码。
maven或gradle插件
smart-doc官方为了方便用户快速和无侵入的集成smart-doc的文档api生成能力,我们开发可相关的maven或者gradle插件。这里也推荐使用插件的方式来使用smart-doc。
https://gitee.com/smart-doc-team/smart-doc-maven-plugin
升级建议
修复了用户反馈的一些bug,本次升级不涉及到api的变更,重点:本次发布的新版gradle插件在多模块中更加智能,gradle插件的用户体验建议升级。
DEMO
使用demo轻松玩转接口文档生成,其他用户案例文档效果展示:https://api.doubans.com/
知名用户
- 科大讯飞
- 一加
- 小米
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网
猜你喜欢:- 无需额外注解的 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 发布
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。
程序员的职业素养
Robert C.Martin / 章显洲、余晟 / 人民邮电出版社 / 2012-9-1 / 49.00元
本书是编程大师Bob 大叔40 余年编程生涯的心得体会, 讲解成为真正专业的程序员需要什么样的态度、原则,需要采取什么样的行动。作者以自己以及身边的同事走过的弯路、犯过的错误为例,意在为后来人引路,助其职业生涯迈上更高台阶。 本书适合所有程序员,也可供所有想成为具备职业素养的职场人士参考。一起来看看 《程序员的职业素养》 这本书的介绍吧!