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

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

内容简介：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完全不需要在侵入到业务代码中写任何注解，复杂嵌套对象自动推导出定义字段结构。
smart-doc代码量很少，如果不能满足你的需求完全可以自己修改源码。

更新内容

修改gitee上bug #I1426C。
修改gitee上bug #I13ZAL,1.7.0~1.7.3 结构优化后产生的bug，建议用户升级。
修改gitee上bug #I13U4C。
修改设置中文语言环境(默认中文)下错误码列表title显示英文的问题。
优化AllInOne的markdown展示，生成时带上自动产生的序号。

升级建议

因为smart-doc 1.7.0做了大量的改造，#I13ZAL是个高频bug，强烈建议升级到高版本。

DEMO

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

用户评价

部分使用者对smart-doc的评价

最强大的doc组件，强制要求了规范，也不会污染代码，欣喜之情溢于言表!
smartdoc从注释入手，即规范强化了文档的编写又能提供源码文档之外的api功能，真的对得起smart的称谓。

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

查看所有标签

猜你喜欢:

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

码农书籍

编程原本

Alexander Stepanov、Paul McJones / 裘宗燕 / 机械工业出版社华章公司 / 2012-1-10 / 59.00元

本书提供了有关编程的一种与众不同的理解。其主旨是，实际的编程也应像其他科学和工程领域一样基于坚实的数学基础。本书展示了在实际编程语言（如C++）中实现的算法如何在最一般的数学背景中操作。例如，如何定义快速求幂算法，使之能使用任何可交换运算。使用抽象算法将能得到更高效、可靠、安全和经济的软件。这不是一本很容易读的书，它也不是能提升你的编程技能的秘诀和技巧汇编。本书的价值是更根本性的，其终极目......一起来看看《编程原本》这本书的介绍吧!

码农工具