api-docs について
api-docsは、TypeScriptとJavaScriptのAPIを文書化するスキルです。公開エクスポートの検出、JSDocの解析と補完、HTTPエンドポイント向けOpenAPI 3.0定義の生成に対応します。
主な機能
- 01公開関数・クラス・インターフェースの検出
- 02JSDocアノテーションの解析
- 03不足するJSDocの追加
- 04OpenAPI 3.0定義の生成
活用シーン
- 01ドキュメントのない公開エクスポートの記述
- 02ソースコードからのAPIリファレンス作成
- 03OpenAPIによるHTTPエンドポイントの記述
MCP 対応
MCPのフックワーカーにdocumentトリガーとAPIスコープを指定して、文書作成タスクをディスパッチします。
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/api-docsを入力して読み込まれたか確認します。
詳細
TypeScript/JavaScript のソースから API ドキュメントを生成します。
- エクスポートをスキャン：すべての公開関数、クラス、インターフェースを検索します
- JSDoc を抽出：
@param、@returns、@throws、@exampleの注釈を解析します - 不足しているドキュメントを生成：ドキュメントがない公開 API に JSDoc を追加します
- OpenAPI 仕様：HTTP エンドポイントの OpenAPI 3.0 定義を生成します
MCP 経由でディスパッチします：mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", scope: "api" })
規約：
- すべての公開エクスポートに JSDoc コメントを付ける必要があります
- 型と説明を含む
@paramを記述します - 型と説明を含む
@returnsを記述します - 既知のエラー条件に対する
@throwsを記述します - 自明でない使い方には
@exampleを記述します
コメント
Markdown 対応