mcpField
A
api-patterns

api-patterns

github.com/redpanda-data开发4.3k51 次安装3 天前更新
代码仓库

关于 api-patterns

api-patterns 是使用 Connect Query 发起 API 调用的编码技能。它为开发者提供数据获取、变更、缓存失效、错误通知和生成的 Protobuf 文件方面的指导。

主要功能

  1. 01Connect Query hooks 使用指南
  2. 02变更后的缓存失效
  3. 03使用 formatToastErrorMessage 处理错误
  4. 04生成的 Protobuf 文件规则

适用场景

  1. 01使用 Connect 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 钩子
  • 使缓存失效
  • 执行变更并进行乐观更新
  • 针对错误显示 Toast 通知

快速参考

操作规则
获取数据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/生成的 protos（请勿编辑）

重新生成 protos：task proto:generate（在仓库根目录运行）

规则

有关查询、变更、缓存失效和错误处理的详细指南，请参阅 rules/ 目录。

评论

支持 Markdown