API Docs
技能 已验证 活跃Generate API documentation from source code with JSDoc and OpenAPI support
To automate the generation and maintenance of API documentation, ensuring consistency and completeness for developers using JSDoc and OpenAPI standards.
功能
- Generate API documentation from source code
- Support for JSDoc annotations (@param, @returns, @throws, @example)
- Automatic generation of missing JSDoc comments
- Generate OpenAPI 3.0 specifications for HTTP endpoints
使用场景
- Automatically document new API endpoints or functions
- Ensure all public APIs have JSDoc comments with types and descriptions
- Maintain a consistent OpenAPI specification alongside source code
- Generate documentation for codebases written in TypeScript and JavaScript
非目标
- Generating documentation for languages other than TypeScript/JavaScript
- Creating UI documentation or user guides
- Performing runtime analysis of API behavior
工作流
- Scan source code for public exports
- Extract JSDoc annotations
- Generate missing JSDoc comments
- Generate OpenAPI 3.0 specification for HTTP endpoints
实践
- Documentation Generation
- API Specification
先决条件
- Node.js environment
- Source code with JSDoc comments (recommended)
安装
请先添加 Marketplace
/plugin marketplace add ruvnet/ruflo/plugin install ruflo-docs@ruflo质量评分
已验证类似扩展
Deepinit
100Deep codebase initialization with hierarchical AGENTS.md documentation
Cleanup Cycles
100Detect and untangle circular dependencies. Runs madge/skott (TS), pycycle (Py), or compiler-only checks (Go/Rust). Auto-fixes leaf-extractable cycles; reports core cycles for human review. Use when the user asks to find circular imports, fix dependency cycles, or untangle module graph. Example queries — "find circular imports", "fix dependency cycles", "untangle our module graph", "why is madge complaining".
Netlify Identity
100用于身份验证、用户注册、登录、密码恢复、OAuth 提供商、基于角色的访问控制或保护路由和函数。始终使用 `@netlify/identity`。切勿使用 `netlify-identity-widget` 或 `gotrue-js` — 它们已弃用。
Vue Router Best Practices
100Vue Router 4 patterns, navigation guards, route params, and route-component lifecycle interactions.
Sentry React Router Framework Sdk
100Full Sentry SDK setup for React Router Framework mode. Use when asked to "add Sentry to React Router Framework", "install @sentry/react-router", or configure error monitoring, tracing, profiling, session replay, logs, or user feedback for a React Router v7 framework app.
Code Documenter
99Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.