<h1 align="center">Smart-Doc Project</h1>
![maven](https://img.shields.io/maven-central/v/com.github.shalousun/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)
[![chinese](https://img.shields.io/badge/chinese-中文文档-brightgreen)](https://smart-doc-group.github.io/#/zh-cn/)
![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 is a tool that supports both JAVA REST API and Apache Dubbo RPC interface document generation. Smart-doc is
based on interface source code analysis to generate interface documents, and zero annotation intrusion. You only need to
write Javadoc comments when developing, smart-doc can help you generate Markdown or HTML5 document. smart-doc does not
need to inject annotations into the code like Swagger.
[quick start](https://smart-doc-group.github.io/#/)
## Features
- Zero annotation, zero learning cost, only need to write standard JAVA document comments.
- Automatic derivation based on source code interface definition, powerful return structure derivation support.
- Support Spring MVC, Spring Boot, Spring Boot Web Flux (Not support endpoint), Feign ,JAX-RS.
- Supports the derivation of asynchronous interface returns such as Callable, Future, CompletableFuture.
- Support JSR-303 parameter verification specification.
- Support for automatic generation of request examples based on request parameters.
- Support for generating JSON return value examples.
- Support for loading source code from outside the project to generate field comments (including the sources jar
package).
- Support for generating multiple formats of documents: Markdown,HTML5,Asciidoctor,Postman Collection 2.0+,OpenAPI 3.0.
- Support for exporting error codes and data dictionary codes to API documentation.
- The debug html5 page fully supports file upload and download testing.
- Support Apache Dubbo RPC.
## Best Practice
smart-doc + [Torna](http://torna.cn) form an industry-leading document generation and management solution, using
smart-doc to complete Java source code analysis and extract annotations to generate API documents without intrusion, and
automatically push the documents to the Torna enterprise-level interface document management platform.
![smart-doc+torna](https://raw.githubusercontent.com/shalousun/smart-doc/master/images/smart-doc-torna-en.png)
## Building
You could build with the following commands. (Java 1.8 is required to build the master branch)
```
mvn clean install -Dmaven.test.skip=true
```
## TODO
- Jakarta RS-API 2.x
## Who is using
These are only part of the companies using smart-doc, for reference only. If you are using smart-doc,
please [add your company here](https://github.com/smart-doc-group/smart-doc/issues/12) to tell us your scenario to make
smart-doc better.
![IFLYTEK](https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/iflytek.png)
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/oneplus.png" title="OnePlus" width="83px" height="83px"/>
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/xiaomi.png" title="Xiaomi" width="170px" height="83px"/>
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/neusoft.png" title="东软集团" width="170px" height="83px"/>
<img src="https://www.hand-china.com/static/img/hand-logo.svg" title="上海汉得信息技术股份有限公司" width="260px" height="83px"/>
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/shunfeng.png" title="顺丰" width="83px" height="83px"/>
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/zhongkezhilian.png" title="zhongkezhilian" width="272px" height="83px"/>
<img src="https://gitee.com/smart-doc-team/smart-doc/raw/master/images/known-users/mafenwo.png" title="马蜂窝" width="150px" height="83px"/>
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/yuanmengjiankang.png" title="yuanmengjiankang" width="260px" height="83px"/>
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/known-users/tianbo-tech.png" title="tianbo tech" width="127px" height="70px"/>
## Acknowledgements
Thanks to [JetBrains SoftWare](https://www.jetbrains.com) for providing free Open Source license for this project.
<img src="https://raw.githubusercontent.com/smart-doc-group/smart-doc/master/images/jetbrains-variant-3.png" width="260px" height="220px"/>
## License
Smart-doc is under the Apache 2.0 license. See
the [LICENSE](https://github.com/smart-doc-group/smart-doc/blob/master/LICENSE)
file for details.
## Contact
Email: [email protected]
没有合适的资源?快使用搜索试试~ 我知道了~
smart-doc接口文档生成工具 v2.6.7
共243个文件
java:166个
png:25个
md:15个
1 下载量 198 浏览量
2023-04-21
09:29:26
上传
评论
收藏 2.69MB ZIP 举报
温馨提示
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-doc在业内率先提出基于JAVA泛型定义推导的理念, 完全基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释,
资源推荐
资源详情
资源评论
收起资源包目录
smart-doc接口文档生成工具 v2.6.7 (243个子文件)
AllInOne.adoc 3KB
DubboAllInOne.adoc 2KB
ApiDoc.adoc 2KB
Dubbo.adoc 1KB
ErrorCodeList.adoc 196B
search_all.js.btl 7KB
search.js.btl 4KB
DubboSearch.btl 4KB
AllInOne.css 61KB
AllInOne.css 29KB
font.css 21KB
index.css 5KB
markdown.css 4KB
xt256.min.css 745B
.gitignore 290B
说明.htm 4KB
debug-all.html 21KB
AllInOne.html 18KB
DubboAllInOne.html 17KB
index.html 16KB
debug.html 13KB
error.html 6KB
dict.html 6KB
HtmlApiDoc.html 905B
IRestDocTemplate.java 59KB
DocUtil.java 40KB
ParamsBuildHelper.java 38KB
JaxrsDocBuildTemplate.java 37KB
JavaClassUtil.java 32KB
JsonBuildHelper.java 25KB
ApiConfig.java 22KB
DocBuilderTemplate.java 19KB
AbstractOpenApiBuilder.java 17KB
TornaUtil.java 16KB
RpcDocBuildTemplate.java 15KB
JavaClassValidateUtil.java 14KB
PropertyNamingStrategies.java 14KB
ProjectDocConfigBuilder.java 13KB
SwaggerBuilder.java 12KB
OpenApiBuilder.java 12KB
SolonDocBuildTemplate.java 12KB
IBaseDocBuildTemplate.java 12KB
ApiMethodDoc.java 11KB
DocClassUtil.java 11KB
PostmanJsonBuilder.java 11KB
RpcDocBuilderTemplate.java 11KB
FormDataBuildHelper.java 10KB
SpringBootDocBuildTemplate.java 10KB
HighlightStyle.java 9KB
IHeaderHandler.java 8KB
HtmlApiDocBuilder.java 8KB
DocGlobalConstants.java 7KB
BaseDocBuilderTemplate.java 7KB
JaxrsPathHandler.java 7KB
ApiParam.java 6KB
JavaFieldUtil.java 6KB
Apis.java 6KB
ApiParamTreeUtil.java 6KB
ApiDoc.java 5KB
ApiReqParam.java 5KB
DocJavaField.java 5KB
TornaConstants.java 5KB
IRpcDocTemplate.java 5KB
TornaBuilder.java 5KB
SpringMVCRequestMappingHandler.java 5KB
JaxrsHeaderHandler.java 5KB
SolonRequestMappingHandler.java 5KB
MediaType.java 5KB
IDocBuildTemplate.java 4KB
OpenApiSchemaUtil.java 4KB
DocJavaMethod.java 4KB
RpcJavaMethod.java 4KB
ApiDataDictionary.java 4KB
IRequestMappingHandler.java 4KB
CustomField.java 4KB
RpcApiDoc.java 4KB
RpcTornaBuilder.java 4KB
ApiDocBuilder.java 4KB
ApiErrorCodeDictionary.java 4KB
AdocDocBuilder.java 4KB
UrlBean.java 4KB
HttpParam.java 4KB
BeetlTemplateUtil.java 3KB
RpcHtmlBuilder.java 3KB
RpcApiAllData.java 3KB
TornaRequestInfo.java 3KB
CurlUtil.java 3KB
RpcMarkdownBuilder.java 3KB
DocPathUtil.java 3KB
Main.java 3KB
RpcAdocBuilder.java 3KB
RevisionLog.java 3KB
BoxReturnFilter.java 3KB
ApiAllData.java 3KB
ApiRequestExample.java 3KB
DocTags.java 3KB
DocUrlUtil.java 3KB
JakartaJaxrsAnnotations.java 2KB
CurlRequest.java 2KB
PropertyNameHelper.java 2KB
共 243 条
- 1
- 2
- 3
资源评论
网创学长
- 粉丝: 2493
- 资源: 914
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功