# @fastify/type-provider-zod 中文文档

规范地址：https://npmcn.com/package/%40fastify/type-provider-zod/

版本：1\.0\.3
npm 元数据更新时间：2026-10-25T13:46:53.180Z
中文译文更新时间：2026-11-14T11:22:42.399Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40fastify/type-provider-zod
原文对照：https://npmcn.com/package/%40fastify/type-provider-zod/?lang=original
项目主页：https://github.com/fastify/fastify-type-provider-zod
源码仓库：https://github.com/fastify/fastify-type-provider-zod

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

- 包体积（解压后）：125 kB，45 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：zod \>=4\.2\.0，fastify ^5\.5\.0，openapi-types ^12\.1\.3，@fastify/swagger \>=9\.5\.1
- 首次发布：2026-04-19T17:02:10.647Z
- 最新版本发布：2026-10-25T13:46:52.757Z
- 近 30 天下载量：234001（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

快速化的 Zod 类型提供者@ 5

## 安装

```sh
npm install @fastify/type-provider-zod
```

也可以使用：`pnpm add @fastify/type-provider-zod`、`yarn add @fastify/type-provider-zod`、`bun add @fastify/type-provider-zod`

## README

# @ fastify/ type- professor- zod

[![NPM Version](https://img.shields.io/npm/v/@fastify/type-provider-zod.svg)](https://www.npmjs.com/package/@fastify/type-provider-zod) [![NPM Downloads](https://img.shields.io/npm/dm/@fastify/type-provider-zod.svg)](https://www.npmjs.com/package/@fastify/type-provider-zod) [![Build Status](https://github.com/fastify/fastify-type-provider-zod/actions/workflows/ci.yml/badge.svg)](https://github.com/fastify/fastify-type-provider-zod/actions/workflows/ci.yml)

类型提供者 [佐德语Name](https://github.com/colinhacks/zod)。 。 。 .

## 安装

```sh
npm i zod
npm i @fastify/type-provider-zod
```

## Zod 兼容性

`@fastify/type-provider-zod` 只与Zod v4.2 或以后工作.

> **重要 (v0+)**
> 
> 从 **页:1**这个图书馆使用Zod的 `.encode()` 编号 : `.decode()` 引入的 API **佐德4.1号**。 。 。 . 由于这个变化, **响应序列化现在基于 `z.output<T>` 改为 `z.input<T>`**。 。 。 .

## 怎样用?

```ts
import type { ZodTypeProvider } from '@fastify/type-provider-zod';
import {
  serializerCompiler,
  validatorCompiler,
} from '@fastify/type-provider-zod';
import { z } from 'zod/v4';

const app = Fastify();

// Add schema validator and serializer
app.setValidatorCompiler(validatorCompiler);
app.setSerializerCompiler(serializerCompiler);

app.withTypeProvider<ZodTypeProvider>().route({
  method: 'GET',
  url: '/',
  // Define your schema
  schema: {
    querystring: z.object({
      name: z.string().min(4),
    }),
    response: {
      200: z.string(),
    },
  },
  handler: (req, res) => {
    res.send(req.query.name);
  },
});

app.listen({ port: 4949 });
```

您也可以将选项传递给 `serializerCompiler` 函数 :

```ts
type ZodSerializerCompilerOptions = {
  replacer?: ReplacerFunction;
};
```

```ts
import Fastify from 'fastify';
import {
  createSerializerCompiler,
  validatorCompiler,
} from '@fastify/type-provider-zod';

const app = Fastify();

const replacer = function (key, value) {
  if (this[key] instanceof Date) {
    return { _date: value.toISOString() };
  }
  return value;
};

// Create a custom serializer compiler
const customSerializerCompiler = createSerializerCompiler({ replacer });

// Add schema validator and serializer
app.setValidatorCompiler(validatorCompiler);
app.setSerializerCompiler(customSerializerCompiler);

// ...

app.listen({ port: 4949 });
```

## 如何与 @ fastify/ swagger 一起使用

```ts
import fastify from 'fastify';
import fastifySwagger from '@fastify/swagger';
import fastifySwaggerUI from '@fastify/swagger-ui';
import { z } from 'zod/v4';
import type { ZodTypeProvider } from '@fastify/type-provider-zod';
import {
  jsonSchemaTransform,
  createJsonSchemaTransform,
  serializerCompiler,
  validatorCompiler,
} from '@fastify/type-provider-zod';

const app = fastify();
app.setValidatorCompiler(validatorCompiler);
app.setSerializerCompiler(serializerCompiler);

app.register(fastifySwagger, {
  openapi: {
    info: {
      title: 'SampleApi',
      description: 'Sample backend service',
      version: '1.0.0',
    },
    servers: [],
  },
  transform: jsonSchemaTransform,

  // You can also create transform with custom skiplist of endpoints that should not be included in the specification:
  //
  // transform: createJsonSchemaTransform({
  //   skipList: [ '/documentation/static/*' ]
  // })
});

app.register(fastifySwaggerUI, {
  routePrefix: '/documentation',
});

const LOGIN_SCHEMA = z.object({
  username: z.string().max(32).describe('Some description for username'),
  password: z.string().max(32),
});

app.after(() => {
  app.withTypeProvider<ZodTypeProvider>().route({
    method: 'POST',
    url: '/login',
    schema: { body: LOGIN_SCHEMA },
    handler: (req, res) => {
      res.send('ok');
    },
  });
});

async function run() {
  await app.ready();

  await app.listen({
    port: 4949,
  });

  console.log(`Documentation running at http://localhost:4949/documentation`);
}

run();
```

## 自定义错误响应

您可以将自定义处理请求和响应验证错误添加到您的固化错误处理器中 :

```ts
import { hasZodFastifySchemaValidationErrors } from '@fastify/type-provider-zod';

fastifyApp.setErrorHandler((err, req, reply) => {
  if (hasZodFastifySchemaValidationErrors(err)) {
    return reply.code(400).send({
      error: 'Response Validation Error',
      message: 'Request doesn't match the schema',
      statusCode: 400,
      details: {
        issues: err.validation,
        method: req.method,
        url: req.url,
      },
    });
  }

  if (isResponseSerializationError(err)) {
    return reply.code(500).send({
      error: 'Internal Server Error',
      message: 'Response doesn't match the schema',
      statusCode: 500,
      details: {
        issues: err.cause.issues,
        method: err.method,
        url: err.url,
      },
    });
  }

  // the rest of the error handler
});
```

## 如何创造回旋装置?

提供后,此软件包将使用 `jsonSchemaTransformObject` 函数。 您将计划与全球 Zod 注册注册, 并指定它们 `id`。 。 。 . `fastifySwagger` 之后将创建一个OpenAPI文档,该文档将引用计划.

以下例子对 `User` 计划,包括 `User` openAPI 文档中的 schema.

```ts
import fastifySwagger from '@fastify/swagger';
import fastifySwaggerUI from '@fastify/swagger-ui';
import fastify from 'fastify';
import { z } from 'zod/v4';
import type { ZodTypeProvider } from '@fastify/type-provider-zod';
import {
  jsonSchemaTransformObject,
  jsonSchemaTransform,
  serializerCompiler,
  validatorCompiler,
} from '@fastify/type-provider-zod';

const USER_SCHEMA = z.object({
  id: z.number().int().positive(),
  name: z.string().describe('The name of the user'),
});

z.globalRegistry.add(USER_SCHEMA, { id: 'User' });

const app = fastify();
app.setValidatorCompiler(validatorCompiler);
app.setSerializerCompiler(serializerCompiler);

app.register(fastifySwagger, {
  openapi: {
    info: {
      title: 'SampleApi',
      description: 'Sample backend service',
      version: '1.0.0',
    },
    servers: [],
  },
  transform: jsonSchemaTransform,
  transformObject: jsonSchemaTransformObject,
});

app.register(fastifySwaggerUI, {
  routePrefix: '/documentation',
});

app.after(() => {
  app.withTypeProvider<ZodTypeProvider>().route({
    method: 'GET',
    url: '/users',
    schema: {
      response: {
        200: USER_SCHEMA.array(),
      },
    },
    handler: (req, res) => {
      res.send([]);
    },
  });
});

async function run() {
  await app.ready();

  await app.listen({
    port: 4949,
  });

  console.log(`Documentation running at http://localhost:4949/documentation`);
}

run();
```

## 如何创建插件 ?

```ts
import { z } from 'zod/v4';
import type { FastifyPluginAsyncZod } from '@fastify/type-provider-zod';

const plugin: FastifyPluginAsyncZod = async function (fastify, _opts) {
  fastify.route({
    method: 'GET',
    url: '/',
    // Define your schema
    schema: {
      querystring: z.object({
        name: z.string().min(4),
      }),
      response: {
        200: z.string(),
      },
    },
    handler: (req, res) => {
      res.send(req.query.name);
    },
  });
};
```

## 如何指定不同的 OpenAPI 目标

您可以使用 : `createJsonSchemaTransform` 函数与 `zodToJsonConfig.target` 选项.

默认目标为"openapi-3.0",用于将“openapi”字段设置为"3.0.x"的文档;而将“trop-2020-12”用于将“openapi”字段设置为"3.1.x"的文档.

### 使用量

```typescript
import { createJsonSchemaTransform } from '@fastify/type-provider-zod';

// For OpenAPI 3.0.x compatibility
const transform = createJsonSchemaTransform({
  zodToJsonConfig: { target: 'openapi-3.0' },
});

// For OpenAPI 3.1+
const transform = createJsonSchemaTransform({
  zodToJsonConfig: { target: 'draft-2020-12' },
});
```

## 许可证

许可证根据 [麻省理工学院](https://npmcn.com/package/%40fastify/type-provider-zod/LICENSE)。 。 。 .

## 常见问题

### @fastify/type-provider-zod 是什么？

快速化的 Zod 类型提供者@ 5

### 如何安装 @fastify/type-provider-zod？

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

### @fastify/type-provider-zod 支持 TypeScript 吗？

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

### @fastify/type-provider-zod 支持 ESM 还是 CommonJS？

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

### @fastify/type-provider-zod 可以商用吗？

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

### @fastify/type-provider-zod 的下载量有多少？

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

### @fastify/type-provider-zod 还在维护吗？

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