Java Restful API 文档生成工具 smart-doc

Apache-2.0
Java
跨平台
2018-08-23
上官胡闹

完善个人资料领开源豆,速来抽奖!>>>

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

功能特性

  • 零注解、零学习成本、只需要写标准java注释。
  • 基于源代码接口定义自动推导,强大的返回结构推导。
  • 支持Spring MVC,Spring Boot,Spring Boot Web Flux(controller书写方式)。
  • 支持Callable,Future,CompletableFuture等异步接口返回的推导。
  • 支持JavaBean上的JSR303参数校验规范、支持分组校验。
  • 对json请求参数的接口能够自动生成模拟json参数。
  • 对一些常用字段定义能够生成有效的模拟值。
  • 支持生成json返回值示例。
  • 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。
  • 支持生成多种格式文档:Markdown、HTML5、Asciidoctor、Postman json。
  • 轻易实现在Spring Boot服务上在线查看静态HTML5 api文档。
  • 开放文档数据,可自由实现接入文档管理系统。
  • 支持生成Postman Colloection数据一键到入到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使用文档

Demo

demo地址:https://gitee.com/sunyurepository/api-doc-test.git

的码云指数为
超过 的项目
加载中

评论(11)

翻越高山
翻越高山
对代码规范要求太高了
上官胡闹
上官胡闹 软件作者
其实也不高,代码规范了更方便维护
noday
noday
有最佳实践吗,怎么用比较好
宝贵
宝贵
最好能从javadoc中提取参数,返回值,和Exception等。
yonghu86
yonghu86
不错
浮生若梦E
浮生若梦E
加油
吕兵阳
吕兵阳
swagger虽然耦合很严重,但是这个也直接避免了一些懒惰的开发人员改接口不改注释的习惯。如果纯javadoc优点是0侵入和耦合,但是缺点是一些懒惰的开发人员可能会漏掉。
风里的叶子
风里的叶子
https://gitee.com/treeleaf/xDoc 基于Java的代码注释生成接口文档的框架与工具,同时附带基于Spring MVC/Boot的接口文档生成
本杰明
本杰明
每个方法要写注释,单独的postmapping必须加(""),还没有启动成功,规则不比swagger少啊
上官胡闹
上官胡闹 软件作者
零注解,也无需学习一些奇葩自定义注释模板,一切遵从原生。智能化生成模拟数据。
西瓜芝麻
西瓜芝麻
怎么连个地址也没有呢

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

smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分...

今天 10:05

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

05/11 08:37

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

04/20 09:48

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

03/31 09:27

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

03/23 09:46

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

03/16 09:15

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

02/05 09:36

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

smart-doc是一个java restful api文档生成工具, smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要写上java的标准注释,smart-doc就能帮你生成一个简易明了的Mar...

01/03 11:22

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

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。 smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解...

2019/12/16 11:03

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

smart-doc 是一个 java restful api 文档生成工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到...

2019/12/02 11:30

没有更多内容

加载失败,请刷新页面

暂无问答

smart-doc功能使用介绍

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

2018/10/22 23:33
2.3W
4
使用 Smart SDK 快速开发 Java Web 应用

本文是《轻量级 Java Web 框架架构设计》的系列博文。 1 环境要求 操作系统:Windows Java:1.6+ Maven:3.0+ 2 安装 Smart SDK 2.1 下载程序包 点击 这里 下载 Smart SDK 程序包。 2.2 解压...

2013/10/17 15:37
3.9K
5
关于java web restful api文档的重新探索

谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性。 如果代码有生命,为什么不换种方式和它对话! 一、背景 没有背景...

2018/08/20 22:40
1W
8
将 Hessian 集成到 Smart 中

本文是《轻量级 Java Web 框架架构设计》的系列博文,为您展示如何将 Hessian 集成到 Smart 中。

2013/12/26 00:02
4.1K
11
Atitit s2018 s3 doc list alldvc.docx .docx s2018 s3f doc compc s2018 s3f doc homepc sum doc...

Atitit s2018 s3 doc list alldvc.docx .docx s2018 s3f doc compc s2018 s3f doc homepc sum doc dvcCompc dtS312 s2018 s3f doc compc\Atitit PathUtil 工具新特性新版本 v8 s312.docx s20...

2018/05/01 20:00
18
0
SmartWatch2开发-环境搭建1

参考Sony官网学习搭建SmartWatch2的开发环境

2013/12/06 13:54
181
0
【Smart插件】smart-plugin-mybatis 介绍

smart-plugin-mybatis 是Smart框架的一个Mybatis插件,使用这个插件你可以比较方便的使用Mybatis。 这里主要介绍如何在Smart中使用该插件。 smart-plugin-mybatis插件将mybatis的配置信息从m...

2014/04/09 21:29
1.7K
3
[dev] Go语言查看doc与生成API doc

类似与javadoc,go也可以自动生成doc文档。 方法有两个: 1. 使用go doc工具 可以查看它的详细文档: go help doc 示例: 在这个目录下,我创建一个api包 ╰─>$ pwd /home/tong/Src/go/src...

2019/04/28 14:59
15
0
跟 UMU 一起玩 OpenWRT(入门篇11):文件共享

跟 UMU 一起玩 OpenWRT(入门篇11):文件共享服务

2014/07/27 00:52
4.3K
0
python __doc__ 文档说明

1.__doc__ 2.help() 3.pydoc

2016/06/08 12:16
62
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部