SuperAPI AI 工具集

api-patterns

编程与开发

查看项目

更新于 10-16 02:02

技能介绍

用途

api-patterns 是 redpanda-data/console 项目中的一项技能,专注于在使用 Connect Query 进行 API 调用时提供规范指引,帮助开发者在涉及 mutations(数据变更)、queries(数据查询)或数据获取的场景下正确编写代码并处理响应。

主要能力

该技能以规则和参考文档的形式组织,提供 API 调用的基本规范,包括:

  • 使用 Connect Query hooks 进行 API 调用。
  • 数据获取的规则指引(见 use-connect-query.md)。
  • mutation 之后的缓存失效处理(见 api-invalidate-cache.md)。
  • 错误处理,建议在 onError 中使用 formatToastErrorMessage 配合 toast 通知(见 api-toast-errors.md)。
  • Protobuf 文件不可编辑的约束(见 protobuf-no-edit.md)。

使用方式

技能以「快速参考」表的形式给出不同操作对应的规则文件,并列出关键位置:

  • /src/react-query/:存放 Connect Query hooks。
  • /src/protogen/:存放生成的 protos,不可编辑。

重新生成 protos 的方式为:从仓库根目录执行 task proto:generate。

更详细的查询、mutation、缓存失效和错误处理指引位于 rules/ 目录。

适用场景

适用于在该项目前端代码中发起 API 请求、编写 Connect Query hooks、处理 mutation 后缓存更新,以及统一错误提示的场景。

限制

该技能本身不包含具体实现代码,主要作为规则与文档集合使用。关于运行平台、是否收费、安装命令及实际效果,资料中暂未提供。