smart-doc 1.8.7 发布，Java 零注解文档生成工具

栏目: 软件资讯 · 发布时间: 3年前

内容简介：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。
轻易实现在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接口文档生成。

更新内容

1. 增加对java接口的分析，例如Jpa的分页Page类。
2. 增强对使用@RequestBody绑定参数方法的解析。
3. 增加将驼峰字段格式转化为下划线格式。
4. maven插件和gradle插件提供includes支持，方便自行配置加载第三方库。
5. fix #32.
6. 增加文档接口根据接口标题排序功能。

重要发布内容

根据用户的反馈，我们在smart-doc上增加了对dubbo rpc接口的扫描生成api文档，你再也不用手写rpc接口的文档了。

maven插件

从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin，推荐使用最新版本的插件。当然官方的gradle插件已经开发完毕，

gradle插件目前在测试阶段，使用gradle的用户可以先拉取gradle插件源码自行编译使用等待后续测试完发布。

插件使用文档

升级建议

本次发布主要是发布了更新的东西比较多插件，尤其是首次发布多dubbo rpc的支持

DEMO

使用demo轻松玩转接口文档生成

知名用户

科大讯飞
一加
小米

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

编程.建筑

保罗·科茨 / 2012-9 / 45.00元

《编程•建筑》简单明了地介绍了计算机算法与程序用于建筑设计的历史，解释了基本的算法思想和计算机作为建筑设计工具的运用。作为计算机辅助设计的先驱，保罗·科茨通过多年讲授的计算、设计的教学内容和实例研究，向我们展示了算法思维。《编程•建筑》提供了详细、可操作的编码所需要的技术和哲学思想，给读者一些代码和算法例子的认识。一起来看看《编程.建筑》这本书的介绍吧!

码农工具