zod

To create a zod schema, specify the client property as zod, and it will automatically generate in the target file. Ensure to configure zod properly in your project by referring to Zod.

Example of orval.config.js

1 module.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:

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

How use generated zod object

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

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