OpenAPI-TS 项目中仅使用 Zod 插件时的生成行为解析

在 OpenAPI-TS 项目中，开发者有时会遇到一个常见情况：当配置中仅指定了 Zod 插件时，系统不会自动生成其他类型的输出文件（如 TypeScript 类型定义和 SDK 文件）。这个现象实际上是一个有意为之的设计决策，而非系统缺陷。

插件系统的设计原理

OpenAPI-TS 采用了显式配置优先的原则。当开发者在配置文件中明确指定了 plugins 数组时，系统会完全按照这个数组来执行，而不会自动合并默认插件。这种设计带来了几个优势：

1. 配置的确定性：开发者可以精确控制要启用的插件
2. 避免隐式行为：所有生成行为都明确反映在配置中
3. 更好的可维护性：配置文件完整记录了所有使用的插件

实际应用场景

假设开发者只需要 Zod 验证相关的输出，可以这样配置：

export default defineConfig({
  plugins: ["zod"]
})

但如果需要同时保留默认功能（类型定义和SDK生成）并添加Zod支持，则应采用扩展默认插件的方式：

import { defaultPlugins } from '@hey-api/openapi-ts'

export default defineConfig({
  plugins: [...defaultPlugins, 'zod']
})

最佳实践建议

1. 明确需求：首先确定项目中真正需要的生成内容
2. 渐进式配置：从默认配置开始，逐步添加特殊需求
3. 文档参考：详细阅读插件系统的说明文档
4. 版本控制：当修改插件配置时，做好版本控制以便回滚

这种设计虽然初期可能让开发者感到困惑，但长期来看提供了更清晰、更可控的配置体验，避免了隐式行为带来的不确定性。项目维护者也承诺会进一步完善相关文档，使这一设计理念更加透明易懂。