zod

要创建 zod 模式，请将 client 属性指定为 zod，它将在目标文件中自动生成。通过参考 Zod 确保在项目中正确配置 zod。

orval.config.js 示例

1module.exports = {
2  petstore: {
3    output: {
4      client: 'zod',
5      mode: 'single',
6      target: './src/gen/zod',
7    },
8    input: {
9      target: './petstore.yaml',
10    },
11  },
12};

将创建一个实现文件，包含 OpenAPI 规范中每个模式的 zod 对象，如下所示：

1export const createPetsBody = zod.object({
2  id: zod.number(),
3  name: zod.string(),
4  tag: zod.string().optional(),
5});

如何使用生成的 zod 对象

自动生成的 zod 对象可以按通常的方式使用。

1import type { z } from 'zod';
2import { createPetsBodyItem } from './src/gen/zod/swaggerPetstore.ts';
3
4const pet = { id: 1, name: 'pet name', tag: 'tag' };
5
6// 解析
7const parsedPet = createPetsBodyItem.parse(pet);
8console.log(parsedPet);
9// => Object { id: 1, name: "pet name", tag: "tag" }
10
11// 推断类型
12type Pet = z.infer<typeof createPetsBodyItem>;
13console.log(pet as Pet);
14// => Object { id: 1, name: "pet name", tag: "tag" }