Zod

To create a Zod schema, specify the client property as zod, and it will automatically be generated in the target file. Ensure that Zod is configured properly in your project by referring to the Zod documentation.

Example of 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};

An implementation file will be created, containing a Zod object for each schema in your OpenAPI Specification, as illustrated below:

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

How to Use the Generated Zod Object

The Zod object generated automatically can be utilized in the usual manner.

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// parsing
7const parsedPet = createPetsBodyItem.parse(pet);
8console.log(parsedPet);
9// => Object { id: 1, name: "pet name", tag: "tag" }
10
11// inferred type
12type Pet = z.infer<typeof createPetsBodyItem>;
13console.log(pet as Pet);
14// => Object { id: 1, name: "pet name", tag: "tag" }