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

2021-07-19 698

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具，smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。

smart-doc 完全基于接口源码分析来生成接口文档，完全做到零注解侵入，你只需要按照 java 标准注释编写，smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污染，那请拥抱 smart-doc 吧！

功能特性

支持接口 debug。
零注解、零学习成本、只需要写标准 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 和其他工具的支持

功能特性	smart-doc	swagger
代码侵入	无	注解侵入性严重
集成复杂度	简单，只需插件	偏复杂
插件支持	有gradle和maven插件	无插件
openapi规范支持	支持openapi 3.0	完全支持openapi的版本
CI构建集成	可在ci构建阶段使用 maven或者gradle命令启动插件生成文档	不支持
集中化文档中心集成	已经和torna企业级接口文档管理平台对接	不支持
维护持续性	值得信赖，开源后用户基础多，一直持续维护	全球用户多，开源维护值得信赖
接口debug	2.0.0版本开始已经支持debug，页面比swagger漂亮太多了。	支持

Smart-doc 从 2.0.0 后几乎实现了 swagger ui 的功能，并且比 swagger ui 更简洁大方，也更符合国内开发者的诉求。当然 smart-doc 的功能也已经

超过了 swagger 为 java 开发者提供的功能。当然 smart-doc 本身是只支持扫描代码生成 openapi 3.0 的文档的，也可以将生成的 openapi 3.0 文档导入到其他ui中渲染展示。

更新内容

增加pathPrefix配置项用于配置上下文，引入该配置项后serverUrl仅用于配置服务器地址。
支持请求头常量设置解析。
支持使用JsonIgnoreProperties和JSONType注解去忽略多字段。
修改部分文档设置allInOneDocFileName无效的bug,#131 。
修复dubbo rpc文档模板格式错误 #https://gitee.com/smart-doc-team/smart-doc/issues/I40ZGE .
支持配置添加拦截器中设置全局请求参数，#https://github.com/smart-doc-group/smart-doc/issues/132 .
修复部分类型mock未推送到torna的bug。

debug 页面效果

maven或gradle插件

smart-doc 官方为了方便用户快速和无侵入的集成 smart-doc 的文档 api 生成能力，我们开发可相关的 maven 或者 gradle 插件。这里也推荐使用插件的方式来使用 smart-doc。

https://gitee.com/smart-doc-team/smart-doc-maven-plugin

官方推荐方案

smart-doc + Torna 组成行业领先的文档生成和管理解决方案，使用smart-doc无侵入完成Java源代码分析和提取注释生成API文档，自动将文档推送到Torna企业级接口文档管理平台。

smart-doc+Torna文档自动化

smart-doc在国内很多企业中被用来替换了swagger，甚至是在国内Top 3内的大厂都有smart-doc的二次开发版本。Torna未来的目标是追赶和超越Yapi。smart-doc针对java spring技术栈的解析能力目前为业内最强(不服就拿工具来跑smart-doc的解析demo)。所以smart-doc+Torna的方案威力巨大，Torna目前处于高速迭代期，欢迎体验Torna，我们努力为社区提供高效好用的接口文档解决方案。

升级建议

smart-doc 这个版本最大的变更是对接了Torna企业级接口文档管理系统。

DEMO

使用demo轻松玩转接口文档生成，其他用户案例文档效果展示：https://api.doubans.com/

知名用户

科大讯飞
一加
小米

鸣谢

smart-doc也是利用一些开源技术构建起来的，我在这里对下列开源项目表示感谢。

Beetl 国内开源的JAVA模板引擎
QDOX 开源JAVA源代码解析库

微信关注我们

原文链接：https://www.oschina.net/news/151060/smart-doc-2-2-3-released

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

Apache Pulsar 2.8.0 版本发布

关于 Apache Pulsar Apache Pulsar 是 Apache 软件基金会顶级项目，是集消息、存储、轻量化函数式计算为一体的下一代云原生分布式消息流平台，采用了计算与存储分离架构设计，支持多租户、持久化存储、多机房跨区域数据复制，具有强一致性、高吞吐、低延时及高可扩展性等流数据存储特性。 GitHub 地址：http://github.com/apache/pulsar/ 2.8.0 版本更新概述 Apache Pulsar 2.8.0 版本正式发布，新版本中新增许多社区期待的性能优化与新功能。新版本中的主要功能和更新如下：独占 Producer；包管理 API；简化的客户端内存限制设置； Broker Entry Metadata；新 Protobuf 代码生成器；事务点击此处下载 Pulsar 2.8.0。更多详情可以阅读 2.8.0 release note或者观看 2.8.0 解析视频。详细了解 Pulsar 2.8.0，请阅读博客。

2021-07-19

817

carbon 是一个轻量级、语义化、对开发者友好的Golang时间处理库，支持链式调用、农历和gorm、xorm等主流orm。如果您觉得不错，请给个 star 吧 github:github.com/golang-module/carbon gitee:gitee.com/go-package/carbon 更新日志优化IsZero()方法的判断逻辑修复Microsecond()方法获取毫秒数错误的bug 修复SetMicrosecond()方法设置毫秒数错误的bug 修复Lunar().Festival()方法不是任何节气时panic的bug 修复Format()方法无法原样解析的bug, 如carbon.Parse("2020-08-05 13:14:15").Format("\I\t \i\s Y-m-d H:i:s") 修复ParseByFormat()方法无法原样解析的bug，如carbon.ParseByFormat("It is 2020-08-05 13:14:15", "\I\t \i\s Y-m-d H:i:s") 使用github.com/stretchr/...

2021-07-19

674

资源下载

更多资源

Spring

Spring框架（Spring Framework）是由Rod Johnson于2002年提出的开源Java企业级应用框架，旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念，提供核心容器、应用上下文、数据访问集成等模块，支持整合Hibernate、Struts等第三方框架，其适用范围不仅限于服务器端开发，绝大多数Java应用均可从中受益。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

Sublime Text

Sublime Text具有漂亮的用户界面和强大的功能，例如代码缩略图，Python的插件，代码段等。还可自定义键绑定，菜单和工具栏。Sublime Text 的主要功能包括：拼写检查，书签，完整的 Python API ， Goto 功能，即时项目切换，多选择，多窗口等等。Sublime Text 是一个跨平台的编辑器，同时支持Windows、Linux、Mac OS X等操作系统。

WebStorm

WebStorm 是jetbrains公司旗下一款JavaScript 开发工具。目前已经被广大中国JS开发者誉为“Web前端开发神器”、“最强大的HTML5编辑器”、“最智能的JavaScript IDE”等。与IntelliJ IDEA同源，继承了IntelliJ IDEA强大的JS部分的功能。