Zod

WARNING

Zod plugin is currently in beta. The interface might change before it becomes stable. We encourage you to leave feedback on GitHub.

About

Zod is a TypeScript-first schema validation library with static type inference.

Features

• seamless integration with @hey-api/openapi-ts ecosystem
• Zod schemas for request payloads, parameters, and responses

Installation

In your configuration, add zod to your plugins and you'll be ready to generate Zod artifacts. 🎉

import { defaultPlugins } from '@hey-api/openapi-ts';

export default {
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: [
    ...defaultPlugins,
    '@hey-api/client-fetch',
    'zod', 
  ],
};

SDKs

To automatically validate response data in your SDKs, set sdk.validator to true.

import { defaultPlugins } from '@hey-api/openapi-ts';

export default {
  input: 'https://get.heyapi.dev/hey-api/backend',
  output: 'src/client',
  plugins: [
    ...defaultPlugins,
    '@hey-api/client-fetch',
    'zod',
    {
      name: '@hey-api/sdk', 
      validator: true, 
    },
  ],
};

Output

The Zod plugin will generate the following artifacts, depending on the input specification.

Responses

A single Zod schema is generated for all endpoint's responses. If the endpoint describes multiple responses, the generated schema is a union of all possible response shapes.

const zResponse = z.union([
  z.object({
    foo: z.string().optional(),
  }),
  z.object({
    bar: z.number().optional(),
  }),
]);

Request Bodies

If an endpoint describes a request body, we will generate a Zod schema representing its shape.

const zData = z.object({
  foo: z.string().optional(),
  bar: z.union([z.number(), z.null()]).optional(),
});

Parameters

A separate Zod schema is generated for every request parameter.

const zParameterFoo = z.number().int();

const zParameterBar = z.string();

Schemas

A separate Zod schema is generated for every reusable schema.

const zFoo = z.number().int();

const zBar = z.object({
  bar: z.array(z.number().int()).optional(),
});

Examples

You can view live examples on StackBlitz.

Sponsors

Love Hey API? Become our sponsor.

•