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

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

内容简介：smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照j...

smart-doc是一个java restful api文档生成工具，smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释的写，smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档。如果你已经厌倦了swagger等文档工具的无数注解和强侵入污染，那请拥抱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。
轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
开放文档数据，可自由实现接入文档管理系统。

一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。

Smart-doc vs Swagger

smart-doc不是对Swagger造轮子，这是一款用完全不同的理念重新开发的restful api接口文档生成工具。
smart-doc比swagger集成更简单，可以自由生成多种格式的api文档。
smart-doc完全不需要在侵入到业务代码中写任何注解。

更新内容

1. 修改request请求参数中嵌套对象不能解析的bug，参考gitee #I16AN2.
2. controller参数是数组时添加@PathVariable注解会报空指针,参考gitee #I16F6G
3. 新增ApiDataBuilder用于获取smart-doc生成的文档数据，包含header、字典、错误码等。
4. 修改github #9 文档错误bug.
5. 新增接口的@author展示，方法从文档中查到找到接口负责人，生成文档可以选择关闭显示。
6. 重点：smart-doc的maven插件smart-doc-maven-plugin 1.0.0版本发布。

maven插件

从smart-doc 1.7.9版本开始。我们提供了smart-doc的插件smart-doc-maven-plugin。

插件使用文档

升级建议

本次推出了smart-doc-maven-plugin插件，更方便用户在maven项目中集成smart-doc生成文档，也方便在maven项目构建发布中直接使用maven命令

生成项目文档。建议使用插件，通过引入插件方式，即便是不用smart-doc剔除了插件依赖也不会影响项目编译，对项目零影响。

DEMO

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

相关文档

smart-doc文档wiki

以上所述就是小编给大家介绍的《smart-doc 1.7.9 发布，Java 零注解文档生成工具》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

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

码农书籍

How to Design Programs, 2nd Edition

Matthias Felleisen、Robert Bruce Findler、Matthew Flatt、Shriram Krishnamurthi / MIT Press / 2018-5-4 / USD 57.00

A completely revised edition, offering new design recipes for interactive programs and support for images as plain values, testing, event-driven programming, and even distributed programming. This ......一起来看看《How to Design Programs, 2nd Edition》这本书的介绍吧!

码农工具