# @anatine/zod-openapi 中文文档

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

版本：2\.2\.8
npm 元数据更新时间：2025-04-04T15:42:37.447Z
中文译文更新时间：2026-11-06T02:05:48.708Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40anatine/zod-openapi
原文对照：https://npmcn.com/package/%40anatine/zod-openapi/?lang=original
项目主页：https://github.com/anatine/zod-plugins/tree/main/packages/zod-openapi
源码仓库：https://github.com/anatine/zod-plugins

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

- 包体积（解压后）：49.8 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：openapi3-ts ^4\.1\.2，zod ^3\.20\.0
- 首次发布：2021-07-11T21:14:59.952Z
- 最新版本发布：2025-04-04T15:42:37.246Z
- 近 30 天下载量：2809002（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：47（近 12 个月 0 个）

## 中文简介

Zod 到 OpenAPI 转换器

## 安装

```sh
npm install @anatine/zod-openapi
```

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

## README

# @anatine/zod-openapi (英语)

转换 a [佐德语Name](https://github.com/colinhacks/zod) openAPI 计划 `SchemaObject` 定义 [打开api3-ts](https://www.npmjs.com/package/openapi3-ts)

* * *

## 安装

Openapi3-ts和zod都是同级依赖性而不是依赖性包. 虽然 `zod` 操作所必需的, `openapi3-ts` 用于类型广播.

```shell
npm install openapi3-ts zod @anatine/zod-openapi
```

* * *

## 使用量

### 选择任何 Zod 方案并将其转换为 OpenAPI JSON 对象

```typescript
import { generateSchema } from '@anatine/zod-openapi';
const aZodSchema = z.object({
  uid: z.string().nonempty(),
  firstName: z.string().min(2),
  lastName: z.string().optional(),
  email: z.string().email(),
  phoneNumber: z.string().min(10).optional(),
})
const myOpenApiSchema = generateSchema(aZodSchema);
// ...
```

这将生成 OpenAPI 方案 `myOpenApiSchema`

```json
{
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "minLength": 1
    },
    "firstName": {
      "type": "string",
      "minLength": 2
    },
    "lastName": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "phoneNumber": {
      "type": "string",
      "minLength": 10
    }
  },
  "required": [
    "uid",
    "firstName",
    "email"
  ]
}
```

### 通过函数包装器将 Zod 方案扩展为额外的 OpenAPI 方案

```typescript
import { extendApi, generateSchema } from '@anatine/zod-openapi';
const aZodExtendedSchema = extendApi(
      z.object({
        uid: extendApi(z.string().nonempty(), {
          title: 'Unique ID',
          description: 'A UUID generated by the server',
        }),
        firstName: z.string().min(2),
        lastName: z.string().optional(),
        email: z.string().email(),
        phoneNumber: extendApi(z.string().min(10), {
          description: 'US Phone numbers only',
          example: '555-555-5555',
        }),
      }),
      {
        title: 'User',
        description: 'A user schema',
      }
    );
const myOpenApiSchema = generateSchema(aZodExtendedSchema);
// ...
```

...或通过Zod计划扩展:

```typescript
import { extendApi, generateSchema, extendZodWithOpenApi } from '@anatine/zod-openapi';
import {z} from 'zod';

extendZodWithOpenApi(z);

const aZodExtendedSchema = 
      z.object({
        uid: z.string().nonempty().openapi({
          title: 'Unique ID',
          description: 'A UUID generated by the server',
        }),
        firstName: z.string().min(2),
        lastName: z.string().optional(),
        email: z.string().email(),
        phoneNumber: z.string().min(10).openapi({
          description: 'US Phone numbers only',
          example: '555-555-5555',
        }),
      }).openapi(
      {
        title: 'User',
        description: 'A user schema',
      }
    );
const myOpenApiSchema = generateSchema(aZodExtendedSchema);
// ...
```

这将产生一个扩展的策略:

```json
{
  "type": "object",
  "properties": {
    "uid": {
      "type": "string",
      "minLength": 1,
      "title": "Unique ID",
      "description": "A UUID generated by the server"
    },
    "firstName": {
      "type": "string",
      "minLength": 2
    },
    "lastName": {
      "type": "string"
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "phoneNumber": {
      "type": "string",
      "minLength": 10,
      "description": "US Phone numbers only",
      "example": "555-555-5555"
    }
  },
  "required": [
    "uid",
    "firstName",
    "email",
    "phoneNumber"
  ],
  "title": "User",
  "description": "A user schema"
}
```

* * *

## 贷项

-   ### [快速分区- api](https://github.com/RobinTail/express-zod-api)
    
    一个伟大的自由, 提供了一些洞察 处理各种zod类型.
    
-   ### [zod-dto 读取](https://github.com/kbkk/abitia/tree/master/packages/zod-dto)
    
    Lib 提供与 NestJS 一起使用 Zod 的见解
    

* * *

这个库是 nx 单列波的一部分 [@anatine/zod-plugins (韩语)](https://github.com/anatine/zod-plugins)。 。 。 .

## 常见问题

### @anatine/zod-openapi 是什么？

Zod 到 OpenAPI 转换器

### 如何安装 @anatine/zod-openapi？

在项目目录运行 npm install @anatine/zod-openapi，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：openapi3-ts（^4\.1\.2）、zod（^3\.20\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @anatine/zod-openapi 支持 TypeScript 吗？

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

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

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

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

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

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

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

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

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