TongchengOpenSource/smart-doc

Health v2 · maintenance only

Flags: archived

Adoption not part of the score

1584 stars · 295 forks observed · 2026-08-28

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

Smart-doc is a Java API documentation generator that analyzes interface source code to produce docs for REST APIs, WebSocket, Dubbo RPC, and gRPC without requiring annotations. It outputs Markdown, HTML5, Word, Asciidoctor, Postman collections, and OpenAPI 3.0, and can push docs to the Torna platform.

Use cases

• generate rest api documentation from java source code
• produce openapi 3.0 spec without swagger annotations
• generate postman collection from spring boot controllers
• create html api docs from javadoc comments
• document dubbo rpc and grpc interfaces
• generate jmeter test scripts from api definitions
• sync java api docs to torna platform

When to choose

• you want zero-annotation API docs driven by Javadoc comments
• your stack is Spring MVC/Spring Boot, JAX-RS, Feign, Dubbo, or gRPC on the JVM
• you need multiple output formats like OpenAPI, Postman, Markdown, or Word
• you prefer source-code analysis over runtime reflection for doc generation

When to avoid

• your APIs are not on the Java/JVM platform
• you already rely heavily on Swagger/OpenAPI annotation-based workflows
• you need runtime-generated docs from a live server rather than static source analysis

Facets

cli-tool · maturity active

documentation api-documentation parser developer-tools documentation apis web-development jvm cli api-docs javadoc openapi zero-annotation spring-boot dubbo grpc postman

Member repositories

For agents

markdown · JSON · MCP: product_card(name="TongchengOpenSource/smart-doc")