{"library":"apidoc","type":"library","category":null,"description":"apidoc is a command-line utility and programmatic library for generating comprehensive RESTful web API documentation directly from comments embedded within source code. It supports a wide array of programming languages by parsing specialized JSDoc-style comments (e.g., `/** ... */` for JavaScript/Java/C#, `\"\"\" ... \"\"\"` for Python) marked with `@api` tags. The current stable version is 1.2.0, released in February 2024, reflecting a consistent, moderate release cadence focused on stability and feature enhancements. Its key differentiators include a language-agnostic parsing engine that understands various comment styles, a flexible plugin architecture for extending functionality (such as integrating API schemas), and robust programmatic integration options for custom build pipelines. The output is static HTML documentation, making it easy to host and integrate into any project.","language":"javascript","status":"active","version":"1.2.0","tags":["javascript","api","apidoc","doc","documentation","rest","restful"],"last_verified":"Wed May 27","install":[{"cmd":"npm install apidoc","imports":["import { createDoc } from 'apidoc'","apidoc -i src/ -o doc/","import { createDoc, ApidocReturn } from 'apidoc'"]},{"cmd":"yarn add apidoc","imports":[]},{"cmd":"pnpm add apidoc","imports":[]}],"homepage":"https://apidocjs.com","github":"https://github.com/apidoc/apidoc","docs":null,"changelog":null,"pypi":null,"npm":"https://www.npmjs.com/package/apidoc","openapi_spec":null,"status_page":null,"smithery":null,"compatibility":{"summary":{"python_range":"18–22","success_rate":0,"avg_install_s":null,"avg_import_s":null,"wheel_type":null},"url":"https://checklist.day/v1/registry/apidoc/compatibility"}}