w-api-docs について
w-api-docs は、API の情報源に基づいて文書を保守する Basilic のワークフロースキルです。担当するスキーマやルートを変更し、文書化されたジェネレーターを使って、生成物の直接編集を避けます。
主な機能
- 01API の担当ソースとジェネレーターを特定
- 02生成物ではなくスキーマやルートを変更
- 03文書記載の生成コマンドを実行
- 04動作変更時に利用者向け文書を更新
活用シーン
- 01ソースに基づく API 文書の更新
- 02OpenAPI やクライアント生成物の生成
- 03変更された API 動作の文書化
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/w-api-docsを入力して読み込まれたか確認します。
詳細
API ドキュメントは、信頼できる唯一の情報源（TypeBox／Fastify のルート、またはリポジトリで説明されている生成ツール）から更新してください。生成済みの OpenAPI、クライアント、SQL を直接編集しないでください。
- API ドキュメントの MDX と生成ツールの README を読みます。正となるソースと、
package.jsonに記載されている生成スクリプトを特定します。 - 生成済みの成果物ではなく、正となるスキーマまたはルートを変更します。
- ドキュメントに記載された生成コマンドを実行します。リポジトリに差分チェック用のスクリプトがある場合は、それも確認します。
- 動作が変わった場合に限り、利用者向けの MDX を更新します。認証、レート制限、バージョニングに関するポリシーを創作しないでください。
- ドキュメント：動作またはコマンドが変わった場合は
/w-docs。
コメント
Markdown 対応