smart-doc 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
smart-doc 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
smart-doc 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 Apache-2.0
开发语言 Java
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 上官胡闹
适用人群 未知
收录时间 2018-08-23

软件简介

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、Postman Collection2.0+、OpenAPI 3.0+的文档。除此之外smart-doc还支持生成漂亮简洁可调试的html5页面文档。

功能特性

  • 支持生成可直接调试接口的文档页面(文件上传、下载也支持)。
  • 零注解、零学习成本、只需要写标准java注释。
  • 基于源代码接口定义自动推导,强大的返回结构推导。
  • 支持Spring MVC、Spring Boot、Spring Boot Web Flux(controller书写方式)、Feign。
  • 支持Callable,Future,CompletableFuture等异步接口返回的推导。
  • 支持JavaBean上的JSR303参数校验规范、支持分组校验。
  • 对json请求参数的接口能够自动生成模拟json参数。
  • 对一些常用字段定义能够生成有效的模拟值。
  • 支持生成json返回值示例。
  • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
  • 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman collection 2.0+、Open Api 3.0 +。
  • 轻易实现在Spring Boot服务上在线查看静态HTML5文档,支持debug调试接口。
  • 开放文档数据,可自由实现接入文档管理系统。
  • 支持生成Postman Collection数据一键到入到Postman测试接口,参数值默认帮你填好。
  • 从1.8.0版本全面支持json和表单请求解析。
  • 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
  • 支持导出错误码和定义在代码中的各种枚举字典码到接口文档。
  • Maven、Gradle插件化支持,使用极其简单(推荐使用插件)。
  • Apache Dubbo RPC接口文档生成支持。
  • JAX-RS支持

官方推荐方案

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

smart-doc+torna

smart-doc+Torna文档自动化

知名用户

  • 一加【oneplus】

  • 科大讯飞

  • 小米

  • 同程旅行

  • 马蜂窝

  • 东软

  • 汉得信息

Markdown工具推荐

      smart-doc目前能够支持将文档合并到一个Markdown文件,因此你可以使用Typora工具将Markdown转换成pdf、word或者是html文档。

相关文档

smart-doc官方wiki:https://gitee.com/smart-doc-team/smart-doc/wikis/Home

Demo

demo地址:https://gitee.com/smart-doc-team/smart-doc-example-cn.git

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(24) 发布并加入讨论🔥
发表了资讯
2023/12/20 10:02

同程旅行 smart-doc 3.0.1 发布

尊敬的Smart-Doc社区用户: 我们很高兴地宣布,Smart-Doc 3.0.1版本现已正式发布!在这个新版本中,我们对现有的功能进行了优化和改进,并新增了三个重要的功能。在本次的版本迭代中,我们特别感谢五位来自快手、同程旅行等知名互联网企业的研发工程师作为社区贡献者加入我们,是他们的辛勤付出和支持让我们的产品不断完善,更好地服务于广大社区用户。 以下是本次更新的主要内容: 新增功能: 支持基于git管理的增量文档构建,...

3
4
发表了资讯
2023/10/23 09:50

同程旅行 smart-doc 首次版本发布

尊敬的smart-doc用户和开发者: 在国庆佳节前夕,我们很高兴地宣布,smart-doc完成了同程旅行的捐赠之旅。在过去的几周时间里,经过社区贡献者们的不断努力,我们有幸在1024节前发布了smart-doc入住同程旅行开源的首个版本3.0.0。 首先,我们要感谢所有参与这个项目的开发者们。是你们的辛勤工作和无私奉献,使得这个版本的完成成为可能。你们的努力和热情让我们深感骄傲和欣慰。 smart-doc是一个为Java开发者提供的一款强大的文...

8
3
发表了资讯
2023/09/26 10:05

关于 smart-doc 项目捐赠给同程旅行的重要通知

尊敬的smart-doc社区用户们: 在这个秋高气爽的国庆佳节前夕,我想向大家宣布一个重要消息。我决定将smart-doc捐赠给同程旅行。自2018年以来,smart-doc已经陪伴我们走过了五个春秋。在这五年的时间里,我们一起见证了这个项目的成长和发展,它逐渐成长为备受欢迎的API文档生成工具,也一起度过了无数个难忘的时光。然而,随着时间的推移和社区需求的增加,我的个人精力已经无法满足smart-doc未来更好的发展和国际化推广。因此,...

5
2
发表了资讯
2023/09/04 09:35

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
3
发表了资讯
2023/07/10 13:53

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
3
发表了资讯
2023/05/15 10:24

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
2
发表了资讯
2023/05/04 09:44

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
6
发表了资讯
2023/04/03 10:01

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

4
6
发表了资讯
2023/03/13 09:43

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
5
发表了资讯
2023/02/28 10:08

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

2
2
发表了资讯
2023/01/30 10:06

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

2
1
发表了资讯
2022/12/12 09:52

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
4
发表了资讯
2022/11/02 09:56

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
9
发表了资讯
2022/10/17 10:10

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
11
发表了资讯
2022/09/14 09:41

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
5
发表了资讯
2022/09/05 09:30

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

1
3
发表了资讯
2022/08/29 09:49

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
5
发表了资讯
2022/08/22 09:04

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

1
5
发表了资讯
2022/07/11 09:57

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

1
9
发表了资讯
2022/05/05 10:21

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

smart-doc 是一款同时支持 java restful api 和 Apache Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就能帮你生成一个简易明了的 markdown 或是一个像 GitBook 样式的静态 html 文档。如果你已经厌倦了 swagger 等文档工具的无数注解和强侵入污...

0
9
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
暂无内容
24 评论
302 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部