apidoc/apidoc

Health v2 · maintenance only

Flags: archived no_license

Adoption not part of the score

9656 stars · 1627 forks observed · 2026-08-28

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

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

cli-tool · maturity maintenance

api-documentation documentation cli documentation apis developer-tools web-development cli cross-platform rest-api inline-comments doc-generator npm nodejs docker

Member repositories

For agents

markdown · JSON · MCP: product_card(name="apidoc/apidoc")