参考手册Workspace 包参考
api-client API 客户端
前端调用后端 API 的封装,自动处理缓存、重试、错误
这个包基于 TanStack Query,你需要先了解 useQuery / useMutation 的基本用法。如果你是第一次接触,推荐先看 TanStack Query 快速入门。
这是什么
@01mvp/api-client 封装了前端调用后端 API 的通用逻辑。它基于 TanStack Query(一个 React 数据请求库)和 Hono RPC(一个类型安全的 API 调用方案),让你不用重复写请求代码。
简单说:你在组件里用一个 Hook(一个特殊的 React 函数),就能自动拿到后端数据,缓存、重试、加载状态都不用自己管。
能做什么
- 自动缓存:同样的请求不会重复发。刚拿到的数据会缓存一段时间,下次直接用,不用再等网络
- 自动重试:请求失败会自动重试几次(用递增的时间间隔),网络抖动时不用手动刷新
- 请求去重:多个组件同时请求同一个接口,只会发一次请求,结果共享
- 错误处理:统一的错误分类(网络错误、权限不足、未登录等),自动弹提示
- 缓存失效:数据更新后自动刷新相关缓存,不会让用户看到旧数据
- 类型安全:TypeScript 全程类型提示,前后端接口对不上会提前报错
大概原理
React 组件
-> 调用 Hook(比如 useQuery)
-> TanStack Query 检查缓存是否有效
-> 有效 -> 直接返回缓存数据
-> 无效 -> 通过 Hono RPC 发送请求
-> 后端 API 返回数据
-> 更新缓存,返回给组件相关链接
- API 开发指南 -- 如何构建后端 API
- TanStack Query 文档 -- 底层数据请求库
- Hono RPC 文档 -- 类型安全 API 调用方案