软件简介

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

功能特性

• 零注解、零学习成本、只需要写标准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 json数据一键到入到Postman测试接口，参数值默认帮你填好。

• 从1.8.0版本全面支持json和表单请求解析。

• 一款代码注释检测工具，不写注释的小伙伴逃不过法眼了。

• 支持导出错误码和定义在代码中的各种枚举字典码到接口文档。

知名用户

• 一加【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