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

2023-05-04 917

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

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

功能特性

支持生成可调试接口的 html5 格式 API 文档。
零注解、零学习成本、只需要写标准 java 注释。
基于源代码接口定义自动推导，强大的返回结构推导。
支持 Spring MVC,Spring Boot,Spring Boot Web Flux (controller 书写方式),JAX-RS 规范。
支持 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 文档生成。
支持国产 Solon 应用开发框架。

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 中渲染展示。

最近两年，国内也有不少开发者开发了无侵入 idea 文档生成插件，我们也在持续关注这些插件的发展。目前来讲这些 idea 的插件在集成上肯定比 smart-doc 简单，文档生成速度比 smart-doc 快 (idea 插件没有编译这些阶段)，但是目前这些插件都没有解决掉多模块项目以及依赖部模块的场景下中的注释问题，对 smart-doc 发展过程中收集到的用例支持也还不完善。综合看 smart-doc 当前仍然是国内 java web 开发者生成文档的最佳工具。

更新内容

1. 支持扩展对DocJavaMethod 进行数据自定义处理， [#488]( https://github.com/smart-doc-group/smart-doc/issues/488)
2. 修复mock 值中使用cron 表达式后转义值问题。 [#487]( https://github.com/smart-doc-group/smart-doc/issues/487)
3. 支持gson 别名解析。 [#485]( https://github.com/smart-doc-group/smart-doc/pull/485 ）
4. 修复无法获取多层继承的父类接口bug 。 [#480]( https://github.com/smart-doc-group/smart-doc/issues/480)
5. 支持接口中使用多个@RequestBody 。 [#pr475]( https://github.com/smart-doc-group/smart-doc/pull/475)
6. 升级jquery ， [#pr474]( https://github.com/smart-doc-group/smart-doc/pull/474)
7. 修复file 字段required 设置， [#pr470]( https://github.com/smart-doc-group/smart-doc/pull/470)
8. 修复多path 错误， [#466]( https://github.com/smart-doc-group/smart-doc/issues/466)

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 本次对于使用者来说可以平滑升级，2.6 版本系列整改较大，前面的版本稳定性不足，建议升级到最新的 2.6.8。

本次更新也非常感谢社区同学的贡献。

DEMO

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

知名用户

科大讯飞
一加
小米
马蜂窝
顺丰

在 2021 年 8 月 smart-doc 也新增了一些外海的用户。

微信关注我们

原文链接：https://www.oschina.net/news/239382/smart-doc-2-6-8-released

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

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

Simple Admin - Go 语言分布式后台管理系统 v1.0.3 发布

Simple Admin Tools v1.5.4 更新优化： Vben 生成模板优化：删除多余的goctls提示修复：多处 test bugs 优化：更新依赖及最新代码 Simple Admin Backend UI V1.0.3 更新重大更新：同步 vben 至最新版本 v2.10.0 修复：所有已知错误优化：更新 vite 至 v4.3.3，项目编译时间减少 60%+ 优化：适配所有 views 文件修复：用户强制登出bug 注意：新版本 VITE_PROXY 已删除，请直接在 vite.config.ts 配置 proxy Simple Admin Core/Common/Job v1.0.3 更新适配依赖，修复少量问题

2023-05-04

943

PicList 是一个云存储管理和图片上传工具，可以进行包括云端目录查看、文件搜索、批量上传下载和删除文件，复制多种格式文件链接和文件预览等操作。开源地址和软件官网 Github: https://github.com/Kuingsmile/PicList Gitee: https://gitee.com/kuingsmile/PicList 软件官网：https://piclist.cn 下载地址 Windows： https://release.piclist.cn/latest/PicList-Setup-1.8.1-ia32.exehttps://release.piclist.cn/latest/PicList-Setup-1.8.1-x64.exehttps://release.piclist.cn/latest/PicList-Setup-1.8.1.exe Linux： https://release.piclist.cn/latest/PicList-1.8.1.AppImagehttps://release.piclist.cn/latest/piclist_1....

2023-05-04

859

资源下载

更多资源

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

Nacos

Nacos /nɑ:kəʊs/ 是 Dynamic Naming and Configuration Service 的首字母简称，一个易于构建 AI Agent 应用的动态服务发现、配置管理和AI智能体管理平台。Nacos 致力于帮助您发现、配置和管理微服务及AI智能体应用。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据、流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。

Spring

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

Sublime Text

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