mcpField
A
api-patterns

api-patterns

github.com/redpanda-data開発4.3k51 回インストール3 日前に更新
リポジトリ

api-patterns について

api-patterns は Connect Query で API を呼び出すためのコーディングスキルです。データ取得、ミューテーション、キャッシュ無効化、エラー通知、生成された Protobuf ファイルの扱い方を開発者に示します。

主な機能

  1. 01Connect Query フックのガイダンス
  2. 02ミューテーション後のキャッシュ無効化
  3. 03formatToastErrorMessage によるエラー処理
  4. 04生成された Protobuf ファイルのルール

活用シーン

  1. 01Connect Query で API データを取得
  2. 02ミューテーション後のキャッシュ更新
  3. 03整形したミューテーションエラーの表示
  4. 04生成された Protobuf ファイルの編集回避

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/redpanda-data/console --skill api-patterns

インストール後、Claude Code で/api-patternsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

rules/
api-invalidate-cache.md
api-toast-errors.md
protobuf-no-edit.md
use-connect-query.md

詳細

API パターン

Connect Query で API を呼び出し、レスポンスを適切に処理します。

適用条件

  • API を呼び出す場合
  • Connect Query フックを使用する場合
  • キャッシュを無効化する場合
  • ミューテーションと楽観的更新を行う場合
  • エラーをトースト通知する場合

クイックリファレンス

操作ルール
データの取得use-connect-query.md
ミューテーション後api-invalidate-cache.md
エラーの処理api-toast-errors.md（onError で formatToastErrorMessage を使用）
Protobuf ファイルprotobuf-no-edit.md

主な場所

場所用途
/src/react-query/Connect Query フック
/src/protogen/生成された proto（編集禁止）

proto を再生成するには、リポジトリのルートから task proto:generate を実行します。

ルール

クエリ、ミューテーション、キャッシュ無効化、エラー処理の詳細については、rules/ ディレクトリを参照してください。

コメント

Markdown 対応