# YeDaxia/JApiDocs

A magical api documentation generator without annotation for springboot.

Repository: https://github.com/YeDaxia/JApiDocs
Canonical: https://ross.abutalabs.com/products/japidocs
Homepage: https://japidocs.agilestudio.cn/
Language: Java
License: Apache-2.0
License Family: permissive
Topics: api, apidocs, springboot, api-documentation
Last push: 2026-03-19T16:05:36+00:00

## Health v2 (maintenance only)
Score: 65/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 73, release rhythm 35, longevity 100
- inputs: {"age_days": 3517, "days_push": 167, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1695, forks 330 (observed 2026-08-28T04:05:23.838004+00:00)

## What it is
JApiDocs is a Java library that generates API documentation for Spring Boot projects by parsing controller source code, without requiring annotations. It produces HTML docs from code comments and standard Spring MVC patterns.

## Use cases
- generate api docs for springboot project
- document rest apis without annotations
- create html api documentation from java controllers
- auto-generate api reference from source code
- document request params and  bodies for spring controllers

## When to choose
- you have a Spring Boot project with conventional controller code and comments
- you want documentation without adding annotations to every endpoint
- you need simple HTML API docs generated from source

## When to avoid
- your code style deviates from the required conventions
- you need OpenAPI/Swagger ecosystem tooling
- you use non-Spring frameworks

## Facets
- artifact type: library
- maturity: maintenance
- function: api-documentation, documentation, parser
- domain: apis, documentation, web-development, developer-tools
- platform: jvm
- tags: springboot, api-docs, java, html-docs, code-parsing

## Member repositories
- YeDaxia/JApiDocs (main) score 65

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:23.838004+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:37:55.972467+00:00, confidence not recorded.
  - readme: https://github.com/YeDaxia/JApiDocs (fetched 2026-08-28T04:05:23.838004+00:00, sha b8a6e4101924)
- Data as of 2026-08-30T08:39:29.467469+00:00.