开源中国

我们不支持 IE 10 及以下版本浏览器

It appears you’re using an unsupported browser

为了获得更好的浏览体验,我们强烈建议您使用较新版本的 Chrome、 Firefox、 Safari 等,或者升级到最新版本的IE浏览器。 如果您使用的是 IE 11 或以上版本,请关闭“兼容性视图”。
smart-doc首页、文档和下载 - Java Restful API 文档生成工具 - 开源中国社区
全部项目分类
Apache-2.0
Java
跨平台
上官胡闹
分享
收藏
89 人收藏
收录时间:2018-08-23
smart-doc 详细介绍

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

smart-doc

选择将代码托管在码云
你还在等什么

可能是中国最大最好的代码托管平台


大家对 smart-doc 的评论 (全部 7 条评论)
{{repayCom.userName}}
吕兵阳
swagger虽然耦合很严重,但是这个也直接避免了一些懒惰的开发人员改接口不改注释的习惯。如果纯javadoc优点是0侵入和耦合,但是缺点是一些懒惰的开发人员可能会漏掉。
yonghu86
不错
浮生若梦E
加油
上官胡闹
零注解,也无需学习一些奇葩自定义注释模板,一切遵从原生。智能化生成模拟数据。
风里的叶子
https://gitee.com/treeleaf/xDoc 基于Java的代码注释生成接口文档的框架与工具,同时附带基于Spring MVC/Boot的接口文档生成
顶部