https://github.com/smart-doc-group/smart-doc
Smart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-injection.
https://github.com/smart-doc-group/smart-doc
Last synced: about 2 months ago
JSON representation
Smart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-injection.
- Host: GitHub
- URL: https://github.com/smart-doc-group/smart-doc
- Owner: smart-doc-group
- License: apache-2.0
- Created: 2025-11-13T13:13:59.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-12-05T07:50:30.000Z (3 months ago)
- Last Synced: 2026-01-14T04:49:23.546Z (about 2 months ago)
- Language: Java
- Homepage: https://smart-doc-group.github.io/#/zh-cn/?id=smart-doc
- Size: 33.5 MB
- Stars: 13
- Watchers: 2
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
- awesome-repository - smart-doc-team / smart-doc
README
Smart-Doc Project
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://smart-doc-group.github.io/zh/)
## Introduce
`smart-doc[smɑːt dɒk]`is a tool that supports both `JAVA REST API` and `JAVA WebSocket` 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/)**
## Documentation
* [English](https://smart-doc-group.github.io/)
* [中文](https://smart-doc-group.github.io/zh/)
## 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`,`Word`,`Asciidoctor`,`Postman Collection 2.0+`,`OpenAPI 3.0`.
- Support the generation of `Jmeter` performance testing scripts
- Support for generating `Javadoc` documentation for `Java` classes.
- 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`.
- Support `GRPC`
## 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.
## Building
You could build with the following commands. (`JDK 1.8` is required to build the master branch)
```
mvn clean install -Dmaven.test.skip=true
```
## 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.
## Acknowledgements
Thanks to [JetBrains SoftWare](https://www.jetbrains.com) for providing free Open Source license for this project.
## 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： 836575280@qq.com
Twitter：https://x.com/shalousun
If you're based in China, feel free to scan the QR code to join our community QQ group. You're also welcome to follow my personal WeChat Official Account for technical content on Java, Go (Goland), Rust, AI, and more!
社区QQ群
Chinese users are welcome to follow my WeChat Official Account!
