Documentation API avec JSDoc et OpenAPI

Génère automatiquement la documentation API à partir du code TypeScript/JavaScript, incluant JSDoc et spécifications OpenAPI.

Spar Skills Guide Bot
DocumentationIntermédiaire
0029/08/2026
Claude CodeCursorWindsurfCopilotCodex
#api-docs#jsdoc#openapi#typescript#javascript

Recommandé pour


name: api-docs description: Generate API documentation from source code with JSDoc and OpenAPI support argument-hint: "<source-path>" allowed-tools: Bash(npx *) mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch Read Write Grep

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
Skills similaires