# smart-doc **Repository Path**: wu-zhihao/smart-doc ## Basic Information - **Project Name**: smart-doc - **Description**: smart-doc是一款同时支持java restful api和apache dubbo rpc接口文档生成的工具。完全基于注释生成文档，做到零侵入。 - **Primary Language**: Java - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: https://smart-doc-group.github.io/#/zh-cn/ - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 637 - **Created**: 2024-06-25 - **Last Updated**: 2024-06-25 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README

Smart-Doc Project

![maven](https://img.shields.io/maven-central/v/com.ly.smart-doc/smart-doc) [![License](https://img.shields.io/badge/license-Apache%202-green.svg)](https://www.apache.org/licenses/LICENSE-2.0) ![number of issues closed](https://img.shields.io/github/issues-closed-raw/smart-doc-group/smart-doc) ![closed pull requests](https://img.shields.io/github/issues-pr-closed/smart-doc-group/smart-doc) ![java version](https://img.shields.io/badge/JAVA-1.8+-green.svg) ![gitee star](https://gitee.com/smart-doc-team/smart-doc/badge/star.svg) ![git star](https://img.shields.io/github/stars/smart-doc-group/smart-doc.svg) ## Introduce `smart-doc[smɑːt dɒk]`是一款同时支持`JAVA REST API`和`JAVA WebSocket`和`Apache Dubbo RPC`接口文档生成的工具，`smart-doc`在业内率先提出基于`JAVA`泛型定义推导的理念，完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照`Javadoc`标准编写注释， `smart-doc`就能帮你生成一个简易明了的`Markdown`、`HTML5`、`Postman` `Collection2.0+`、`OpenAPI 3.0+`的文档。 $\color{red}{你给我的star，胜过所有读过的诗—smart-doc}$ > 无论你是很有经验的大佬、还是刚入行的萌新。遇到使用疑惑时，我们希望你能仔细阅读smart-doc官方码云的wiki文档。我们将smart-doc及其插件的 > 每一个配置项和可能在日常中遇到的问题都整理到了文档中。仔细阅读文档就是对开源项目最大的支持。查看[快速开始](https://smart-doc-group.github.io/#/zh-cn/) 了解详情 ## Features - 零注解、零学习成本、只需要写标准`JAVA`注释。 - 基于源代码接口定义自动推导，强大的返回结构推导。 - 支持`Spring MVC`、`Spring Boot`、`Spring Boot Web Flux`(`Controller`书写方式)、`Feign`。 - 支持`Callable`、`Future`、`CompletableFuture`等异步接口返回的推导。 - 支持`JavaBean`上的`JSR303`参数校验规范，包括分组验证。 - 对`JSON`请求参数的接口能够自动生成模拟`JSON`参数。 - 对一些常用字段定义能够生成有效的模拟值。 - 支持生成`JSON`返回值示例。 - 支持从项目外部加载源代码来生成字段注释(包括标准规范发布的jar包)。 - 支持生成多种格式文档：`Markdown`、`HTML5`、`Word`、`Asciidoctor`、`Postman Collection`、`OpenAPI 3.0`。开放文档数据，可自由实现接入文档管理系统。 - 支持导出错误码和定义在代码中的各种字典码到接口文档。 - 支持生成`Jmeter`性能测试脚本。 - 支持`Maven`、`Gradle`插件式轻松集成。 - 支持`Apache Dubbo RPC`接口文档生成。 - 支持`Java`类`Javadoc`文档生成。 - 支持基于`Git`管理项目的变更增量文档生成。 - `debug`接口调试`html5`页面完全支持文件上传，下载(`@download tag`标记下载方法)测试。 ## Best Practice `smart-doc` + [Torna](http://torna.cn) 组成行业领先的文档生成和管理解决方案，使用`smart-doc`无侵入完成`Java`源代码分析和提取注释生成`API`文档，自动将文档推送到`Torna[ˈtɔːrnə]`企业级接口文档管理平台。 ![smart-doc+torna](https://gitee.com/smart-doc-team/smart-doc/raw/master/images/smart-doc-torna.png) [smart-doc+Torna文档自动化](https://gitee.com/smart-doc-team/smart-doc/wikis/smart-doc与torna对接?sort_id=3695028) > Torna是由smart-doc官方独家推动联合研发的企业级文档管理系统，因此smart-doc官方不会对接其它任何的外部文档管理系统，例如像showdoc、yapi > 之类的对接请自定内部处理，也不要再给我们提其他文档系统对接的PR。我们核心是把smart-doc+Torna的这套方案打造好。 ## Building 如果你需要自己构建`smart-doc`，那可以使用下面命令，构建需要依赖`JDK 1.8+`。 ``` mvn clean install -Dmaven.test.skip=true ``` ## TODO - GRPC ## License `smart-doc` is under the Apache 2.0 license. See the [LICENSE](https://gitee.com/smart-doc-team/smart-doc/blob/master/LICENSE) file for details. **注意：** `smart-doc`源代码文件全部带有版权注释，使用关键代码二次开源请保留原始版权，否则后果自负！ ## Who is using > 排名不分先后，更多接入公司，欢迎在[https://gitee.com/smart-doc-team/smart-doc/issues/I1594T](https://gitee.com/smart-doc-team/smart-doc/issues/I1594T) 登记（仅供开源用户参考） ![IFLYTEK](https://gitee.com/smart-doc-team/smart-doc/raw/master/images/known-users/iflytek.png)