smart-doc 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
smart-doc 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
授权协议 Apache-2.0
开发语言 Java
操作系统 跨平台
软件类型 开源软件
开发厂商
地区 国产
提 交 者 上官胡闹
适用人群 未知
收录时间 2018-08-23

软件简介

smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于java泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照javadoc标准编写注释, smart-doc就能帮你生成一个简易明了的Markdown、HTML5文档,甚至可以直接生成Postman collection导入到Postman做api接口调试。

功能特性

  • 零注解、零学习成本、只需要写标准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、Open Api 3.0 +。
  • 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
  • 开放文档数据,可自由实现接入文档管理系统。
  • 支持生成Postman Collection数据一键到入到Postman测试接口,参数值默认帮你填好。
  • 从1.8.0版本全面支持json和表单请求解析。
  • 一款代码注释检测工具,不写注释的小伙伴逃不过法眼了。
  • 支持导出错误码和定义在代码中的各种枚举字典码到接口文档。
  • Maven、Gradle插件化支持,使用极其简单(推荐使用插件)。
  • Apache Dubbo RPC接口文档生成支持。

知名用户

  • 一加【oneplus】

  • 科大讯飞

  • 小米

给使用者的建议

  • smart-doc虽然可以关闭注解检测,好的规范更容易让项目变得更容易维护

  • smart-doc的出发的目标不是仅仅为书写接口的开发人员自己测试接口服务的,而是希望导出的文档能够用极少的变更就能做接口服务对接文档。

  • smart-doc主要目的是为了减少接口文档书写和造测试模拟数据

  • smart-doc目前得到了很多使用者的支持,包括一些知名的公司也有研发团队在使用,相信我们能做好一款文档生成工具。

  • smart-doc具备完备的文档,用户在使用过程中能够快速的解决问题。

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/sunyurepository/api-doc-test.git

展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论 (16)

加载中
打分: 力荐
真香
09/23 16:22
回复
举报
请问依赖的jar从哪下载?是需要自己编译吗
07/22 18:12
回复
举报
上官胡闹软件作者
我们是发布到maven中央仓库,配置好maven就可以用了
08/03 09:43
回复
举报
你的demo启动失败,麻烦以后写demo,不要加乱七八糟的东西,很乱,只有你们自己能看明白在短时间
07/06 20:23
回复
举报
上官胡闹软件作者
你可能对这个理解有错误,这不是用来启动的啊,这个是我们写来扫描各种代码样例的,本身不是基于运行生成文档的
07/07 19:26
回复
举报
对代码规范要求太高了
05/11 10:08
回复
举报
上官胡闹软件作者
其实也不高,代码规范了更方便维护
05/11 18:25
回复
举报
有最佳实践吗,怎么用比较好
05/11 18:28
回复
举报
最好能从javadoc中提取参数,返回值,和Exception等。
2019/11/07 10:49
回复
举报
打分: 推荐
不错
2018/09/03 16:34
回复
举报
打分: 力荐
加油
2018/08/30 09:51
回复
举报
swagger虽然耦合很严重,但是这个也直接避免了一些懒惰的开发人员改接口不改注释的习惯。如果纯javadoc优点是0侵入和耦合,但是缺点是一些懒惰的开发人员可能会漏掉。
2018/08/28 20:15
回复
举报
https://gitee.com/treeleaf/xDoc 基于Java的代码注释生成接口文档的框架与工具,同时附带基于Spring MVC/Boot的接口文档生成
2018/08/28 15:14
回复
举报
每个方法要写注释,单独的postmapping必须加(""),还没有启动成功,规则不比swagger少啊
2018/08/28 10:44
回复
举报
更多评论
发表于开发技能专区
10/26 07:48

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

0
5
发表于运维专区
10/13 10:34

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

8
13
发表于程序人生专区
09/21 09:52

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

3
21
09/08 09:56

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

6
23
发表于程序人生专区
08/31 09:33

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

2
19
08/24 09:57

smart-doc 1.9.0 发布,新增 Open Api 3.0+ 支持

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

4
12
发表于服务端专区
08/03 09:51

smart-doc 1.9.1 重要功能发布,Java 零注解文档生成工具

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

7
21
发表于软件架构专区
07/20 09:59

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

1
22
07/06 09:13

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

7
12
发表于开发技能专区
06/22 10:36

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

1
18
06/03 10:05

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释编写,smart-doc就能帮你生成一个简易明了的markdown 或是一个...

8
31
发表于开发技能专区
05/11 08:37

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个...

1
27
发表于软件架构专区
04/20 09:48

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个...

1
16
发表于软件架构专区
03/31 09:27

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个...

1
20
发表于服务端专区
03/23 09:46

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个...

3
28
发表于开发技能专区
03/16 09:15

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个...

3
31
发表于服务端专区
02/05 09:37

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman collection一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个...

0
24
发表于开发技能专区
01/03 11:22

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档和Postman json一键导入的测试数据。如果你不喜欢其他工具强侵入的注解污染,smart-doc给你一个不错的...

3
38
2019/12/16 11:03

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

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc就能帮你生成一个简易明了的Markdown、Html、AsciiDoc文档。如果你已经厌倦了swa...

6
39
发表于软件架构专区
2019/12/02 11:30

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

smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写,smart-doc 就能帮你生成一个简易明了的 Markdown、Html、AsciiDoc 文档,当然还支持...

7
24
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表于开发技能专区
2018/10/22 23:33

smart-doc功能使用介绍

smart-doc从2018年8月份底开源发布以来已经迭代了好几个版本。在这里非常感谢那些敢于用smart-doc去做尝试并积极提出建议的社区用户。因此决定在本博客中重要说明下smart-doc的功能,包括使用介绍。以减少后期用户...

23
23
发表于AI & 大数据专区
2019/11/18 17:44

使用smart-doc,一键controller生成文档--团队自用

1.导入包 <dependency> <groupId>com.github.shalousun</groupId> <artifactId>smart-doc</artifactId> <version>1.7.6</version> <scope>test</scope>...

0
0
发表于AI & 大数据专区
07/02 06:22

开源API文档工具- swagger2 与 smart-doc 比较 与 使用

工具开源地址 swagger2 : https://swagger.io/ smart-doc: https://www.oschina.net/p/smart-doc 国产 两者的比较 swagger2 和 smart-doc 两个开源工具 都可以 使用jar包 生成 api 文档。 相同点: 这个两个工具......

0
0
发表于软件架构专区
07/11 22:11

Springboot2.X + Smart-doc快速构建接口文档工具(75)

1、设置方法注释 首先每个人都应该拥有写注释的规范,IDEA设置如下: 接口统一规范 /** * * @author mujiutian * @date $DATE$ $TIME$ * @param $params$ */ 2、pom依赖添加插件 <plugin> <gr...

0
0
发表了博客
2019/03/19 11:39

Go Doc文档

Go为我们提供了快速生成文档和查看文档的工具,很容易编写查看代码文档。在项目协作过程中,可以帮助我们快速理解代码。 <br/> 查看文档方式有两种:一种是通过终端查看,使用go doc命令,一种是通过网页查看,使用godoc命令 <br/> 通过终端查看文档 go doc命令 $ go doc help usage: go doc [-u] [-c] [package|[packag...

0
0
发表了博客
2019/05/09 15:31

Docker DOC

Docker DOC docker是提供给开发或管理人员的容器化部署项目工具 在linux上运行docker 常用命令 docker 安装 #先更新yum yum update; #设置docker仓库 tee /etc/yum.repos.d/docker.repo <<-'EOF' [dockerrepo] name=Docker Repository baseurl=https://yum.dockerproject.org/repo/main/centos/$releasever/ enabled=1 ...

0
0
发表了博客
2019/04/28 14:59

[dev] Go语言查看doc与生成API doc

类似与javadoc,go也可以自动生成doc文档。 方法有两个: 1. 使用go doc工具 可以查看它的详细文档: go help doc 示例: 在这个目录下,我创建一个api包 ╰─>$ pwd /home/tong/Src/go/src/local/test/api/api.go 代码是这样的: package api import "fmt" type TestApi struct { var1 int var2 int ...

0
0
发表了博客
2016/12/28 15:39

doc命令

基础

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
16 评论
232 收藏
分享
返回顶部
顶部