# @anatine/zod-nestjs 中文文档

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

版本：2\.0\.12
npm 元数据更新时间：2025-04-05T16:41:10.419Z
中文译文更新时间：2026-11-06T02:06:13.679Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：38.6 kB，22 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@anatine/zod-openapi ^2\.0\.1，@nestjs/common ^7\.0\.0 \|\| ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0，@nestjs/swagger ^6\.0\.0 \|\| ^7\.0\.0 \|\| ^8\.0\.0 \|\| ^9\.0\.0 \|\| ^10\.0\.0 \|\| ^11\.0\.0，openapi3-ts ^4\.1\.2，zod ^3\.20\.0
- 首次发布：2021-07-12T00:20:00.373Z
- 最新版本发布：2025-04-05T16:41:10.168Z
- 近 30 天下载量：526258（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 0 个）

## 中文简介

NestJS 的 Zod 帮助方法

## 安装

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

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

## README

# @anatine/zod-nestjs (英语)

帮助使用的方法 [佐德语Name](https://github.com/colinhacks/zod) 在雀巢JS项目.

-   数据验证管
-   补丁到 Swagger 模块

* * *

## 安装

@anatine/zod-openapi, openapi3-ts, 和zod是同伴依赖性而不是依赖性包. 虽然 `zod` 操作所必需的, `openapi3-ts` 用于类型广播. `@anatine/zod-openapi` 实际转换

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

* * *

## 使用量

### 生成一个方案

使用 [佐德语Name](https://github.com/colinhacks/zod) 生成一个计划. 此外,使用 [@anatidae/zod-openapi (英语)](https://github.com/anatine/zod-plugins/tree/main/libs/zod-openapi) 以扩展 OpenAPI 和 Swagger UI 的计划.

示例计划:

```typescript
import { createZodDto } from '@anatine/zod-nestjs';
import { extendApi } from '@anatine/zod-openapi';
import { z } from 'zod';
export const CatZ = extendApi(
  z.object({
    name: z.string(),
    age: z.number(),
    breed: z.string(),
  }),
  {
    title: 'Cat',
    description: 'A cat',
  }
);
export class CatDto extends createZodDto(CatZ) {}
export class UpdateCatDto extends createZodDto(CatZ.omit({ name: true })) {}
export const GetCatsZ = extendApi(
  z.object({
    cats: extendApi(z.array(z.string()), { description: 'List of cats' }),
  }),
  { title: 'Get Cat Response' }
);
export class GetCatsDto extends createZodDto(GetCatsZ) {}
export const CreateCatResponseZ = z.object({
  success: z.boolean(),
  message: z.string(),
  name: z.string(),
});
export class CreateCatResponseDto extends createZodDto(CreateCatResponseZ) {}
export class UpdateCatResponseDto extends createZodDto(
  CreateCatResponseZ.omit({ name: true })
) {}
```

### 使用控制器中的方案

这遵循了创建控制器的标准NestJS方法.

`@nestjs/swagger` 装饰人员应当正常工作.

示例控制器

```typescript
import { ZodValidationPipe } from '@anatine/zod-nestjs';
import {
  Body,
  Controller,
  Get,
  Param,
  Patch,
  Post,
  UsePipes,
} from '@nestjs/common';
import { ApiCreatedResponse } from '@nestjs/swagger';
import {
  CatDto,
  CreateCatResponseDto,
  GetCatsDto,
  UpdateCatDto,
  UpdateCatResponseDto,
} from './cats.dto';
@Controller('cats')
@UsePipes(ZodValidationPipe)
export class CatsController {
  @Get()
  @ApiCreatedResponse({
    type: GetCatsDto,
  })
  async findAll(): Promise<GetCatsDto> {
    return { cats: ['Lizzie', 'Spike'] };
  }
  @Get(':id')
  @ApiCreatedResponse({
    type: CatDto,
  })
  async findOne(@Param() { id }: { id: string }): Promise<CatDto> {
    return {
      name: `Cat-${id}`,
      age: 8,
      breed: 'Unknown',
    };
  }
  @Post()
  @ApiCreatedResponse({
    description: 'The record has been successfully created.',
    type: CreateCatResponseDto,
  })
  async create(@Body() createCatDto: CatDto): Promise<CreateCatResponseDto> {
    return {
      success: true,
      message: 'Cat created',
      name: createCatDto.name,
    };
  }
  @Patch()
  async update(
    @Body() updateCatDto: UpdateCatDto
  ): Promise<UpdateCatResponseDto> {
    return {
      success: true,
      message: `Cat's age of ${updateCatDto.age} updated`,
    };
  }
}
```

注:答复必须使用 `ApiCreatedResponse` 使用时的装饰符 `@nestjs/swagger` 模块.

### 设置您的应用程序

补丁 swagger 使其可以在创建文档之前使用 Zod 类型 .

示例主应用程序

```typescript
import { Logger } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { CatsModule } from './app/cats.module';
import { patchNestjsSwagger } from '@anatine/zod-nestjs';
async function bootstrap() {
  const app = await NestFactory.create(CatsModule);
  const globalPrefix = 'api';
  app.setGlobalPrefix(globalPrefix);
  const config = new DocumentBuilder()
    .setTitle('Cats example')
    .setDescription('The cats API description')
    .setVersion('1.0')
    .addTag('cats')
    .build();
  patchNestjsSwagger(); // <--- This is the hacky patch using prototypes (for now)
  const document = SwaggerModule.createDocument(app, config);
  SwaggerModule.setup('api', app, document);
  const port = process.env.PORT || 3333;
  await app.listen(port, () => {
    Logger.log('Listening at http://localhost:' + port + '/' + globalPrefix);
  });
}
bootstrap();
```

## 未来目标

-   删除依赖 `@nestjs/swagger` 提供Swagger UI.
-   扩展以创建一个快捷的包装( 没有 NestJS )
-   通过Zod验证自动生成客户端侧式 libs.

## 贷项

-   ### [zod-dto 读取](https://github.com/kbkk/abitia/tree/master/packages/zod-dto)
    
    从Zod-dto中广泛使用和启发.

## 常见问题

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

NestJS 的 Zod 帮助方法

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

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

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

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

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

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

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

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

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

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

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

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