用途:在使用外部 API、集成第三方服务、生成类型安全的 API 客户端、实现认证流程时使用;不适用于设计自己的 API、编写 API 测试套件、为自己的 API 构建 SDK。
主要能力:类型化所有请求与响应并做运行时校验;显式失败,抛出带上下文的类型化错误;在客户端层统一处理认证;仅对幂等方法与瞬时故障做带退避的智能重试;在集成层转换 API 数据结构,隔离边界。
必要用法(快速开始清单):获取 API 凭据并定位文档;分析输入,提取 base URL、认证方案、端点、错误格式;选择架构(1-5 个端点用类型化包装器,5-20 个用服务类,20+ 用生成客户端);实现类型、客户端、认证处理与错误分类;为瞬时故障添加重试逻辑并处理速率限制;用模拟响应与错误场景编写测试。
参考文档涵盖:OpenAPI 规范解析与类型生成、客户端生成与 GraphQL、基础客户端与拦截器及服务层、请求配置与响应解析及缓存日志、错误类型层级与分类、退避重试与速率限制及断路器、回退策略与 Result 类型、API 密钥与 Bearer 令牌、OAuth 2.0 授权码与 PKCE 及客户端凭据、JWT 与 HMAC 签名及安全令牌存储、HTTP 模拟(MSW、Nock)与测试夹具、转换器单元测试与服务集成测试、契约测试与 E2E 及 Jest 配置。
限制:不用于设计自有 API、API 测试架构与契约测试 mocking 的选型、以及自有 API 的 SDK 打包,这些场景应使用其他对应技能。资料未提供具体安装命令或代码示例。