# TongchengOpenSource/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.

Repository: https://github.com/TongchengOpenSource/smart-doc
Canonical: https://ross.abutalabs.com/products/smart-doc
Homepage: https://smart-doc-group.github.io/#/
Language: Java
License: Apache-2.0
License Family: permissive
Archived: true
Last push: 2025-12-04T04:05:29+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 55, release rhythm 35, longevity 100
- inputs: {"age_days": 2550, "days_push": 272, "days_rel": 357, "gap_med": 82.5, "n_releases_24m": 5}
- flags: archived
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1584, forks 295 (observed 2026-08-28T04:05:07.398204+00:00)

## What it is
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
- artifact type: cli-tool
- maturity: active
- function: documentation, api-documentation, parser
- domain: developer-tools, documentation, apis, web-development
- platform: jvm, cli
- tags: api-docs, javadoc, openapi, zero-annotation, spring-boot, dubbo, grpc, postman

## Member repositories
- TongchengOpenSource/smart-doc (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:07.398204+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:55:53.780489+00:00, confidence not recorded.
  - readme: https://github.com/TongchengOpenSource/smart-doc (fetched 2026-08-28T04:05:07.398204+00:00, sha 979c3eb8ce2c)
  - homepage: https://smart-doc-group.github.io/#/ (fetched 2026-08-29T11:26:17.926329+00:00, sha ae76956f36f4)
- Data as of 2026-08-30T08:39:29.467469+00:00.