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

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

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照java标准注释的写就能得到一个标准的markdown接口文档。如果你已经厌倦了swagger等文档工具的注解和强侵入污染,那请拥抱smart-doc吧!

功能特性

  • 零注解、零学习成本、只需要写java原生注释

  • 基于源代码接口定义自动推导,强大的返回结构推导

  • 支持springmvc、springboot

  • 目前支持javabean上定义的部分fastjson和jackson注解

  • 支持javabean上基于jsr303参数检验判断参数是否为必须

  • 对json请求参数的接口能够自动推导生成模拟json参数

  • 对一些常用字段定义能够自动生成有效的模拟值

  • 支持生成json返回值示例

  • 支持从项目外部加载源代码来生成字段注释

  • 支持将错误码列表和全接口生成合并到一个markdown中

  • 一款代码注解检测工具,明眼leader都知道接口文档直接反馈出注释情况

知名用户

  • 一加【oneplus】

  • iflytek

给使用者的建议

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

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

  • 目前不提供ui界面主要是我们不认同swagger等类似直接集成到项目的形式,更想将文档数据一键导入小幺鸡、CrapApi等企业级接口文档管理中心【暂不支持】。

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

  • smart-doc拉取了大量的开源项目做了源码解析测试,开发过程中也做了很多实际场景的思考,工具开源的目的不是做着玩,而是想帮助大家解决问题。

Markdown工具推荐

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

相关文档

关于java web restful api文档的重新探索

Demo

demo地址:https://github.com/shalousun/api-doc-test

加载中

评论(7)

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

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

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

12/11 09:22

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

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

10/23 23:12

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

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

09/29 23:11

java 零注解文档生成工具 smart-doc 1.3 发布

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

09/17 09:23

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

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

09/04 23:23

java 零注解文档生成工具 smart-doc 1.1 发布

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

08/30 09:19

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

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

08/26 21:44

没有更多内容

加载失败,请刷新页面

没有更多内容

暂无问答

smart-doc功能使用介绍

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

10/22 23:33
320
1
关于java web restful api文档的重新探索

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

08/20 22:40
2.3K
7
SmartWatch2开发-环境搭建1

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

2013/12/06 13:54
162
0
提问的智慧

http://www.beiww.com/doc/oss/smart-questions.html

2015/04/02 16:08
21
0
使用 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.1K
5
跟 UMU 一起玩 OpenWRT(入门篇11):文件共享

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

2014/07/27 00:52
1K
0
【乱七八糟】国内天气预报查询测试

国内天气预报查询测试

2013/12/11 18:22
112
0
Eclipse轻松玩转SmartFramework

SmartFramework框架和SmartSample都是使用Maven构建,使用IDEA开发的。对于像我这样使用Eclipse,又不熟悉Maven的人来说,想玩转smart多少有些难度。这里是我在Eclipse中运行smart-sample的方...

2013/11/24 21:38
1K
3
python - python debug tips

In this post , we will investigate the techqniues that we can explore to way that we can improve testability and debugability . ## assert ## the simplest way to insert debug inf...

2012/11/26 22:42
338
0
php缩略图帮助方法

public function smart_resize_image($file, $width = 0, $height = 0, $proportional = false, $output = 'file', $delete_original = true, $use_linux_commands = false ) { if ( $height...

2011/10/26 11:15
28
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部