Smart-Doc

A non-intrusive API interface document generator

Smart-Doc is a Java-based API documentation generation tool. It generates comprehensive and accurate documentation by analyzing the source code of your interfaces, requiring no special annotations or modifications in your code, making integration seamless and simple.

What is Smart-Doc?

Quickstart

GitHub

📝️

Zero Intrusion

Generate documentation entirely based on annotations, achieving zero code intrusion.

🔗

Interface Diversity

Supports generating documentation for Java RESTful APIs, Java WebSocket interfaces, Apache Dubbo RPC, and gRPC interfaces.

🔧

Framework Diversity

Supports multiple frameworks including Spring Boot, JAX-RS, and Solon.

📚

Rich Documentation

Capable of generating documentation in various formats such as HTML, Asciidoc, Markdown, OpenAPI, Swagger, Postman, and Word

🔌

Extendable

Allows users to extend supported frameworks using Java SPI.

🚀

Document collaboration

Smart-Doc and Torna create an industry-leading documentation solution. Smart-Doc non-intrusively generates API docs and syncs them with Torna's platform, enhancing team productivity and collaboration.