技能 编程开发 从代码生成API文档

从代码生成API文档

v20260716
api-docs
该工具可自动从TypeScript或JavaScript源代码生成全面的API文档。它扫描所有公共导出,解析包含参数、返回值和异常信息的JSDoc注释,并能为HTTP端点生成标准的OpenAPI 3.0规范,确保API文档的完整性和准确性。
获取技能
311 次下载
概览

Generate API documentation from TypeScript/JavaScript source:

  1. Scan exports: Find all public functions, classes, and interfaces
  2. Extract JSDoc: Parse @param, @returns, @throws, @example annotations
  3. Generate missing docs: Add JSDoc for undocumented public APIs
  4. OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP: mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", scope: "api" })

Conventions:

  • Every public export must have a JSDoc comment
  • Include @param with type and description
  • Include @returns with type and description
  • Include @throws for known error conditions
  • Include @example for non-obvious usage
信息
Category 编程开发
Name api-docs
版本 v20260716
大小 955B
更新时间 2026-07-18
语言