SuperAPI AI 工具集

orval

编程与开发

查看项目

更新于 10-16 03:46

技能介绍

用途:这是一份围绕 Orval 的 OpenAPI TypeScript 客户端生成实践指南,适用于新项目配置 Orval、基于 OpenAPI 规范生成 TypeScript 客户端、将生成的 hooks 与 React Query、SWR 或 Vue Query 集成、编写用于认证与错误处理的自定义 mutator,以及生成 MSW mock 用于测试。

主要能力:共整理 42 条规则,按影响优先级分为 8 类。优先级从高到低为:OpenAPI 规范质量(Critical,spec- 前缀,如唯一 operationId、可复用 schema、用 tags 组织、显式定义响应类型与必填字段);配置架构(Critical,orvalcfg- 前缀,如按 API 规模选输出模式、按框架选 client、schema 分离目录、生成前校验规范、配置 base URL、启用 Prettier 格式化);输出结构与组织(High,output- 前缀,如区分文件扩展名、生成索引文件、统一命名、clean 模式、启用 headers);自定义客户端与 mutator(High,mutator- 前缀,如自定义实例、导出错误类型与 body 包装类型、拦截器、token 刷新、fetch mutator 减小包体积);查询库集成(Medium-High,oquery- 前缀,如全局默认 query 选项、导出 query key 便于缓存失效、无限查询、suspense、AbortSignal 取消、mutation 回调类型);类型安全与校验(Medium,types- 前缀,如生成 Zod schema、严格模式、coerce、useDates、useBigInt);Mock 生成与测试(Medium,mock- 前缀,如生成 MSW handlers、使用 OpenAPI examples、配置延迟、覆盖各 HTTP 状态、生成 mock 索引文件);高级模式(Low,adv- 前缀,如输入转换器、按 operation 覆盖设置、输出转换器、表单数据序列化)。

使用方式:可按规则主题查阅对应参考文件,文档包含章节定义、规则模板与示例(如 spec-operationid-unique);完整展开版见 AGENTS.md。相关技能包括 tanstack-query(消费生成的 hooks)、test-msw(mock 生成的 API 客户端)和 zod(schema 校验)。

限制:资料仅给出规则名称与主题分类,未提供具体配置代码、安装命令、收费信息或平台支持范围,这些内容暂未提供。