# @alt-stack/zod-openapi 中文文档

规范地址：https://npmcn.com/package/%40alt-stack/zod-openapi/

版本：1\.8\.2
npm 元数据更新时间：2026-10-20T15:05:41.050Z
中文译文更新时间：2026-11-05T22:21:43.038Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alt-stack/zod-openapi
原文对照：https://npmcn.com/package/%40alt-stack/zod-openapi/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：592 kB，48 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2025-11-06T02:47:47.530Z
- 最新版本发布：2026-10-20T15:05:37.900Z
- 近 30 天下载量：12777（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 18 个）

## 中文简介

用 TypeScript 代码生成将 OpenAPI 计划转换为 Zod 计划

## 安装

```sh
npm install @alt-stack/zod-openapi
```

也可以使用：`pnpm add @alt-stack/zod-openapi`、`yarn add @alt-stack/zod-openapi`、`bun add @alt-stack/zod-openapi`

## README

# `@alt-stack/zod-openapi`

生成 TypeScript 接口, Zod 4 schemas, 并输入 HTTP `Request`编号 :`Response` 地图来自OpenAPI JSON.

## 安装

```bash
pnpm add zod
pnpm add -D @alt-stack/zod-openapi
```

## 生成

```bash
zod-openapi ./openapi.json --output ./src/generated-api.ts
```

`input` 可能是本地 JSON 路径或 HTTP( S) URL 。 CLI还支持 `--registry` 用于执行定制注册计划, `--include` 用于插入所需进口/定义,以及 `--help`它总是发出路由图;程序生成器选择与 `includeRoutes`。 。 。 .

```typescript
import { openApiToZodTsCode } from "@alt-stack/zod-openapi";

const source = openApiToZodTsCode(document, undefined, {
  includeRoutes: true,
});
```

生成的文件以 do-not-edit 横幅开始. 更改 OpenAPI 源、 注册/ 包含文件, 或生成器选项并重生整个文件 .

## 品牌类型

添加 `x-altstack-brand` 以给其输出一个标出型号的特性方案:

```json
{ "type": "string", "format": "uuid", "x-altstack-brand": "UserId" }
```

发电机发射 `z.string().uuid().brand<"UserId">()` 和出口 `UserId` 类型,使用该包的混凝土类型别名常规。 参考资料, 参数、可选和无效属性、阵列项目和保留工会成员的 商标。 用它生成的图案分析一个值,然后指定给 `UserId`。 。 。 . TypeScript HTTP客户端需要解析出路径参数的品牌标识符. 查询参数和请求机构保留其计划输入类型,包括 无花纹弦. 品牌除了基本计划之外,没有增加运行时间验证.

名称必须是ASCII标识符(`[A-Za-z_][A-Za-z0-9_]*`)而且不得保留 单词或与其它组件类型相撞。 重用不兼容的名称 base 类型产生生成错误。 每种用途都保持自己的验证限制.

## 空的成功反应

宣布的2xx答复,没有 `content` (或带一空 `content` 地图) `z.undefined()` 在生成时 `Response` 地图。 例如,无内容 204 打开 `/v1/sessions/{id}/logout` 生成成功分支 `code: "204"` 财务报告和审定财务报表 `body: undefined` 包括Fettle和Ky客户端 贾森 `null` 遗 物 `null`· ; 非JSON介质类型不被视为空响应.

## 文档

-   [代码生成快速启动](https://npmcn.com/package/apps/docs/docs/codegen/quickstart.md)
-   [常见模式](https://npmcn.com/package/apps/docs/docs/codegen/common-patterns.md)
-   [类型脚本/ Zod OpenAPI API 文档](https://npmcn.com/package/apps/docs/docs/codegen/api/zod-openapi.md)
-   [生成 SDK 形状](https://npmcn.com/package/apps/docs/docs/codegen/api/generated-sdks.md)

## 常见问题

### @alt-stack/zod-openapi 是什么？

用 TypeScript 代码生成将 OpenAPI 计划转换为 Zod 计划

### 如何安装 @alt-stack/zod-openapi？

在项目目录运行 npm install @alt-stack/zod-openapi，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 zod-openapi，可以用 npx zod-openapi 直接运行。

### @alt-stack/zod-openapi 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alt-stack/zod-openapi 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @alt-stack/zod-openapi 可以商用吗？

@alt-stack/zod-openapi 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @alt-stack/zod-openapi 的下载量有多少？

根据 npm 官方下载统计，@alt-stack/zod-openapi 在 2026/10/06 – 2026/11/04 这 30 天内被下载 12,777 次，日均约 426 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alt-stack/zod-openapi 还在维护吗？

最新版本 1\.8\.2 发布于 2026/10/20（18 天前）；至今共发布 21 个版本，其中过去 12 个月发布了 18 个；首次发布于 2025/11/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。