orval by pproenca/dot-skills
npx skills add https://github.com/pproenca/dot-skills --skill orval使用 Orval 从 OpenAPI 规范生成类型安全的 TypeScript 客户端的综合指南。包含 8 个类别共 42 条规则,按影响优先级排序,以指导自动化配置、客户端生成和测试设置。
在以下情况时参考本指南:
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | OpenAPI 规范质量 | 关键 | spec- |
| 2 | 配置架构 | 关键 | orvalcfg- |
| 3 | 输出结构与组织 | 高 |
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者,精准高效
output- |
| 4 | 自定义客户端与 Mutators | 高 | mutator- |
| 5 | 查询库集成 | 中-高 | oquery- |
| 6 | 类型安全与验证 | 中 | types- |
| 7 | 模拟生成与测试 | 中 | mock- |
| 8 | 高级模式 | 低 | adv- |
spec-operationid-unique - 使用唯一且描述性的 operationIdspec-schemas-reusable - 在 components 中定义可复用的模式spec-tags-organization - 使用标签组织操作spec-response-types - 显式定义所有响应类型spec-required-fields - 显式标记必填字段orvalcfg-mode-selection - 根据 API 规模选择输出模式orvalcfg-client-selection - 根据框架要求选择客户端orvalcfg-separate-schemas - 将模式分离到专用目录orvalcfg-input-validation - 在生成前验证 OpenAPI 规范orvalcfg-baseurl-setup - 正确配置基础 URLorvalcfg-prettier-format - 启用自动代码格式化output-file-extension - 为生成的代码使用不同的文件扩展名output-index-files - 生成索引文件以便清晰导入output-naming-convention - 配置一致的命名约定output-clean-target - 启用清理模式以实现一致的重新生成output-headers-enabled - 在生成的函数中启用 headersmutator-custom-instance - 使用自定义 mutator 配置 HTTP 客户端mutator-error-types - 从 mutator 导出自定义错误类型mutator-body-wrapper - 导出 body 类型包装器以进行请求转换mutator-interceptors - 使用拦截器处理横切关注点mutator-token-refresh - 在 mutator 中处理令牌刷新mutator-fetch-client - 使用 fetch mutator 以减少包大小oquery-hook-options - 全局配置默认查询选项oquery-key-export - 导出查询键以进行缓存失效oquery-infinite-queries - 为分页端点启用无限查询oquery-suspense-support - 启用 suspense 模式以获得流式 UXoquery-signal-cancellation - 传递 AbortSignal 以取消请求oquery-mutation-callbacks - 使用生成的 mutation 选项类型types-zod-validation - 生成 Zod 模式以进行运行时验证types-zod-strict - 启用 Zod 严格模式以获得更安全的验证types-zod-coerce - 使用 Zod 强制转换进行类型转换types-use-dates - 启用 useDates 以生成 Date 类型types-bigint-support - 启用 useBigInt 以支持大整数mock-msw-generation - 为测试生成 MSW 处理器mock-use-examples - 使用 OpenAPI 示例生成逼真的模拟数据mock-delay-config - 配置模拟响应延迟mock-http-status - 为所有 HTTP 状态码生成模拟数据mock-index-files - 生成模拟索引文件以便轻松设置adv-input-transformer - 使用输入转换器进行规范预处理adv-operation-override - 按操作覆盖设置adv-output-transformer - 使用输出转换器修改生成的代码adv-form-data-handling - 配置表单数据序列化阅读单独的参考文件以获取详细说明和代码示例:
tanstack-query 技能test-msw 技能zod 技能如需包含所有展开规则的完整指南,请参阅:AGENTS.md
每周安装量
104
代码仓库
GitHub 星标数
86
首次出现
2026年1月20日
安全审计
安装于
gemini-cli87
codex86
claude-code83
opencode83
cursor79
github-copilot76
Comprehensive guide for generating type-safe TypeScript clients from OpenAPI specifications using Orval. Contains 42 rules across 8 categories, prioritized by impact to guide automated configuration, client generation, and testing setup.
Reference these guidelines when:
| Priority | Category | Impact | Prefix |
|---|---|---|---|
| 1 | OpenAPI Specification Quality | CRITICAL | spec- |
| 2 | Configuration Architecture | CRITICAL | orvalcfg- |
| 3 | Output Structure & Organization | HIGH | output- |
| 4 | Custom Client & Mutators | HIGH | mutator- |
| 5 | Query Library Integration | MEDIUM-HIGH | oquery- |
| 6 | Type Safety & Validation | MEDIUM | types- |
| 7 | Mock Generation & Testing | MEDIUM | mock- |
| 8 | Advanced Patterns | LOW | adv- |
spec-operationid-unique - Use unique and descriptive operationIdsspec-schemas-reusable - Define reusable schemas in componentsspec-tags-organization - Organize operations with tagsspec-response-types - Define all response types explicitlyspec-required-fields - Mark required fields explicitlyorvalcfg-mode-selection - Choose output mode based on API sizeorvalcfg-client-selection - Select client based on framework requirementsorvalcfg-separate-schemas - Separate schemas into dedicated directoryorvalcfg-input-validation - Validate OpenAPI spec before generationorvalcfg-baseurl-setup - Configure base URL properlyorvalcfg-prettier-format - Enable automatic code formattingoutput-file-extension - Use distinct file extensions for generated codeoutput-index-files - Generate index files for clean importsoutput-naming-convention - Configure consistent naming conventionsoutput-clean-target - Enable clean mode for consistent regenerationoutput-headers-enabled - Enable headers in generated functionsmutator-custom-instance - Use custom mutator for HTTP client configurationmutator-error-types - Export custom error types from mutatormutator-body-wrapper - Export body type wrapper for request transformationmutator-interceptors - Use interceptors for cross-cutting concernsmutator-token-refresh - Handle token refresh in mutatormutator-fetch-client - Use fetch mutator for smaller bundle sizeoquery-hook-options - Configure default query options globallyoquery-key-export - Export query keys for cache invalidationoquery-infinite-queries - Enable infinite queries for paginated endpointsoquery-suspense-support - Enable suspense mode for streaming UXoquery-signal-cancellation - Pass AbortSignal for request cancellationoquery-mutation-callbacks - Use generated mutation options typestypes-zod-validation - Generate Zod schemas for runtime validationtypes-zod-strict - Enable Zod strict mode for safer validationtypes-zod-coerce - Use Zod coercion for type transformationstypes-use-dates - Enable useDates for Date type generationtypes-bigint-support - Enable useBigInt for large integer supportmock-msw-generation - Generate MSW handlers for testingmock-use-examples - Use OpenAPI examples for realistic mocksmock-delay-config - Configure mock response delaysmock-http-status - Generate mocks for all HTTP status codesmock-index-files - Generate mock index files for easy setupadv-input-transformer - Use input transformer for spec preprocessingadv-operation-override - Override settings per operationadv-output-transformer - Use output transformer for generated code modificationadv-form-data-handling - Configure form data serializationRead individual reference files for detailed explanations and code examples:
tanstack-query skilltest-msw skillzod skillFor the complete guide with all rules expanded: AGENTS.md
Weekly Installs
104
Repository
GitHub Stars
86
First Seen
Jan 20, 2026
Security Audits
Gen Agent Trust HubPassSocketPassSnykWarn
Installed on
gemini-cli87
codex86
claude-code83
opencode83
cursor79
github-copilot76
lark-cli 共享规则:飞书资源操作指南与权限配置详解
39,000 周安装
OpenClaw专家技能clawpilot:AI代理安全配置、自动更新与核心架构指南
118 周安装
盲点侦探:系统识别非虚构写作缺失内容,提升内容全面性与可信度
120 周安装
OpenClaw Feeds RSS聚合器:新闻、游戏、金融信息源一键获取,支持流式JSON输出
122 周安装
union-search-skill:跨平台联合搜索工具,支持20+平台无API密钥搜索
118 周安装
Ant Design Vue 4.x 中文指南:Vue 3 UI 组件库安装、使用与API详解
126 周安装
API认证最佳实践指南:JWT、OAuth 2.0、API密钥安全实现与Node.js示例
120 周安装