SuperAPI AI 工具集

ssd-react-api

编程与开发

查看项目

更新于 10-15 21:36

技能介绍

用途:在 React 项目中按 SSD 标准完成 API 调用、React Query hook 编写、NSwag 生成 API client,以及 HTTP 请求与响应处理。

主要能力与规则:HTTP 请求使用 Axios,服务端状态管理使用 TanStack React Query。所有 API 相关文件必须放在 src/app/api/。创建 API client 有两种方式:优先用 NSwag 生成(推荐),或手写。React Query hooks 文件按 Controller 命名并以 .query.ts 结尾。每个 query 文件都必须声明 queryKeys 对象。必须处理 API 的错误响应(isSuccess 检查)。

文件结构:src/app/api/ 下,NSwag 生成的 client 以 .client.ts 结尾(如 orderApi.client.ts),手写文件如 orderApi.ts,React Query hooks 如 order.query.ts;涉及多个 API 时可建子文件夹,如 sale/ 下放 saleApi.client.ts 与 slip.query.ts。

使用方式:方式一(推荐)先在 .env 设置 API_URL,再运行 npm run code-gen,生成的 src/api/api.ts 按标准重命名。方式二在 NSwag 无法满足时手写 Axios client,需声明响应 Interface,并按 GET/POST/PUT 封装函数,在 catch 中处理 _error.response,在 then 中检查 isSuccess,不成功则抛出异常;React Query hooks 使用 useQuery 与 useMutation,并设置 staleTime、cacheTime、refetchOnWindowFocus 及 onSuccess/onError 回调。

适用场景:React 项目中需要统一 API 调用规范、自动生成客户端代码或管理服务端缓存状态时。

限制:资料未提供安装步骤、依赖版本、NSwag 配置细节、收费与价格信息;示例代码仅为规范示意,实际接口与类型以项目为准。