Skip to main content

api-docs

Generate API documentation from source code with JSDoc and OpenAPI support

설치로 이동

소스 정보

저장소
ruvnet/ruflo
최근 소스 활동
2026년 7월 17일 03:06
감지된 SKILL.md 언어
영어
스타
73,010
포크
8,665

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

SKILL.md 표시 중

SKILL.md
소스 지침 · 읽기 전용 미리보기
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
GitHub에서 보기