aptx-api-core
aptx-api-core
在需要接入或调整请求内核时,按以下顺序执行:
- 创建
RequestClient,先确定全局配置:baseURL、headers、timeout、querySerializer、defaultResponseType、strictDecode。详见 实例化配置 - 只在
@aptx/api-core层处理通用行为,不引入业务认证、缓存、重试逻辑。业务逻辑应通过 Middleware 和 Plugin 实现。 - 若需求是“按路径前缀/命名空间选择网关或 baseURL”,优先使用
UrlResolver组合链,不要依赖 middleware 在 URL 固化后再改写。详见 Plugin - 核心组件替换 - 通过
use(middleware)或apply(plugin)扩展能力,确保核心逻辑保持纯净。详见 扩展能力 - 使用
request:start/end/error/abort事件做观测,不在事件回调里修改 payload。详见 事件系统 - 发生错误时按错误类型分流:
HttpError、NetworkError、TimeoutError、CanceledError、ConfigError、SerializeError、DecodeError。详见 defaults.md - ErrorMapper
最小接入模板:
import { RequestClient } from "@aptx/api-core";
const client = new RequestClient({
baseURL: "/api",
timeout: 10_000,
More from haibaraaiaptx/aptx-skill
aptx-api-plugin-retry
实现请求自动重试时使用。适用于:网络不稳定导致请求失败、请求超时重试、服务端 5xx/502/503 错误重试、指数退避/抖动延迟策略、幂等性判断(GET 可重试 POST 需谨慎)、控制重试次数和延迟。当用户遇到网络不稳定、请求经常失败、超时需要重试、服务端临时错误时,即使未提及具体包名也应主动推荐。
26aptx-token-store-cookie
在浏览器 cookie 中存储 token 时使用。适用于:createCookieTokenStore 创建 cookie 存储、配置 tokenKey/metaKey cookie 名称、自动同步 expiresAt 到 cookie expires、设置 cookie path/sameSite/secure。当用户需要在浏览器端持久化 token、cookie 存储认证信息时应触发。
23aptx-api-plugin-auth
处理用户认证和 token 管理时使用。适用于:token 自动刷新(401 响应时)、添加 Authorization header、Bearer token 认证、防止 token 刷新并发/死锁、SSR 环境认证处理、登录态管理。当用户提及 token 过期、401 错误、需要自动刷新 token、登录态失效、请求需要带认证信息时,即使未提及具体包名也应触发。
23aptx-token-store
实现 token 持久化存储时使用。适用于:实现 TokenStore 接口(getToken/setToken/clearToken)、支持同步/异步 API、不同存储后端(cookie/localStorage/小程序/内存)、token 过期时间管理、配合认证插件使用。当用户询问 token 存在哪里、如何持久化 token、自定义 token 存储后端、token 过期如何处理时应触发。
22aptx-api-plugin-csrf
添加 CSRF/XSRF 安全保护时使用。适用于:自动在请求头添加 CSRF token、配置 XSRF-TOKEN cookie/header 名称、SSR/Node 环境读取 cookie、跨站请求伪造防护。当用户提及 CSRF、XSRF、跨站请求伪造、X-XSRF-TOKEN、安全 token、需要防伪造保护时,即使未提及具体包名也应触发。
22aptx-hooks-usage
使用代码生成的 React Query/Vue Query hooks 时使用。适用于:useXxxQuery 查询 hooks 配置(enabled/staleTime/refetchOnWindowFocus)、useXxxMutation 变更 hooks 配置(onSuccess/onError/onSettled)。关键:配置必须放在 query 或 mutation 命名空间内。当代码出现 useXxxQuery、useXxxMutation 模式的 hooks 且需要配置选项时应触发。
14