# apidoc/apidoc

RESTful web API Documentation Generator.

Repository: https://github.com/apidoc/apidoc
Canonical: https://ross.abutalabs.com/products/apidoc
Homepage: http://apidocjs.com
Language: JavaScript
License: NOASSERTION
License Family: other
Archived: true
Last push: 2024-02-16T09:29:16+00:00

## Health v2 (maintenance only)
Score: 10/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 4883, "days_push": 929, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: archived, no_license
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 9656, forks 1627 (observed 2026-08-28T04:10:36.584524+00:00)

## What it is
apiDoc is a Node.js CLI tool that generates RESTful web API documentation from inline @api annotations in source code comments. It supports many languages (JavaScript, Java, PHP, Python, Ruby, Go, and more) and can also be used programmatically via its API.

## Use cases
- generate api documentation from code comments
- document restful web apis
- produce html docs for my api endpoints
- extract api docs from javascript or php source
- create api reference site from inline annotations

## When to choose
- you document REST APIs via inline comments in a supported language
- you want a self-contained HTML documentation site generated by a CLI
- you need language-agnostic API doc generation across a polyglot codebase

## When to avoid
- the project is no longer actively maintained, so avoid it for new projects needing ongoing support
- you need OpenAPI/Swagger spec output rather than apidoc's own format
- you want docs generated from route definitions or spec files instead of comments

## Facets
- artifact type: cli-tool
- maturity: maintenance
- function: api-documentation, documentation, cli
- domain: documentation, apis, developer-tools, web-development
- platform: cli, cross-platform
- tags: rest-api, inline-comments, doc-generator, npm, nodejs, docker

## Member repositories
- apidoc/apidoc (main) score 10

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:36.584524+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-29T17:21:18.850389+00:00, confidence not recorded.
  - readme: https://github.com/apidoc/apidoc (fetched 2026-08-28T04:10:36.584524+00:00, sha 834b920c09e7)
  - homepage: http://apidocjs.com (fetched 2026-08-29T08:21:30.430056+00:00, sha b94146c088a8)
  - registry_npm: https://registry.npmjs.org/apidoc (fetched 2026-08-29T08:21:30.434781+00:00, sha b5858026ca0f)
- Data as of 2026-08-30T08:39:29.467469+00:00.