@kubb/swagger-zod 🦙

With the Swagger Zod plugin you can use Zod to validate your schema's based on a Swagger file.

Installation

bun

bun add @kubb/swagger-zod @kubb/swagger

pnpm

pnpm add @kubb/swagger-zod @kubb/swagger

npm

npm install @kubb/swagger-zod @kubb/swagger

yarn

yarn add @kubb/swagger-zod @kubb/swagger

Options

output

Relative path to save the Zod schemas. When output is a file it will save all models inside that file else it will create a file per schema item.

INFO

Type: string
Default: 'zod'

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  output: {
    path: './zod',
  },
})

output.exportAs

Name to be used for the export * as from './'

INFO

Type: string

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  output: {
    path: './zod',
    exportAs: 'schemas',
  },
})

output.extName

Add an extension to the generated imports and exports, default it will not use an extension

INFO

Type: string

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  output: {
    path: './zod',
    extName: '.js',
  },
})

output.exportType

Define what needs to exported, here you can also disable the export of barrel files

INFO

Type: 'barrel' | 'barrelNamed' | false

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  output: {
    path: './zod',
    exportType: 'barrel',
  },
})

group

Group the Zod schemas based on the provided name.

group.type

Tag will group based on the operation tag inside the Swagger file.

Type: 'tag'
Required: true

group.output

Relative path to save the grouped Zod schemas. {{tag}} will be replaced by the current tagName.

Type: string
Example: zod/{{tag}}Controller => zod/PetController
Default: '${output}/{{tag}}Controller'

group.exportAs

Name to be used for the export * as {{exportAs}} from './

Type: string
Default: '{{tag}}Schemas'

INFO

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  group: { type: 'tag', output: './schemas/{{tag}}Schemas' },
})

typed

Use TypeScript(@kubb/swagger-ts) to add type annotation.

INFO

Type: boolean

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  typed: true,
})

dateType

Choose to use date or datetime as JavaScript Date instead of string.
See datetimes.

TYPE

false

z.string()

'string'

z.string().datetime()

'stringOffset'

z.string().datetime({ offset: true })

'stringLocal'

z.string().datetime({ local: true })

'date'

z.date()

INFO

Type: false | 'string' | 'stringOffset' | 'stringLocal' | 'date'
Default: 'string'

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  dateType: 'string',
})

unknownType

Which type to use when the Swagger/OpenAPI file is not providing more information.

TYPE

'any'

z.any()

'unknown'

z.unknown()

INFO

Type: 'any' | 'unknown'
Default: 'any'

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  unknownType: 'any',
})

include

Array containing include parameters to include tags/operations/methods/paths.

TYPE

export type Include = {
  type: 'tag' | 'operationId' | 'path' | 'method'
  pattern: string | RegExp
}

INFO

Type: Array<Include>

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  include: [
    {
      type: 'tag',
      pattern: 'store',
    },
  ],
})

exclude

Array containing exclude parameters to exclude/skip tags/operations/methods/paths.

TYPE

export type Exclude = {
  type: 'tag' | 'operationId' | 'path' | 'method'
  pattern: string | RegExp
}

INFO

Type: Array<Exclude>

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  exclude: [
    {
      type: 'tag',
      pattern: 'store',
    },
  ],
})

override

Array containing override parameters to override options based on tags/operations/methods/paths.

TYPE

export type Override = {
  type: 'tag' | 'operationId' | 'path' | 'method'
  pattern: string | RegExp
  options: PluginOptions
}

INFO

Type: Array<Override>

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  override: [
    {
      type: 'tag',
      pattern: 'pet',
      options: {
        dateType: 'stringOffset',
      },
    },
  ],
})

transformers

transformers.name

Override the name of the Zod schema that is getting generated, this will also override the name of the file.

INFO

Type: (name: string, type?: "function" | "type" | "file" ) => string

import { pluginZod } from '@kubb/swagger-zod'

const plugin = pluginZod({
  transformers: {
    name: (name) => {
      return `${name}Client`
    },
  },
})

templates

Make it possible to override one of the templates.

TIP

See templates for more information about creating templates.
Set false to disable a template.

TYPE

import type { Operations } from '@kubb/swagger-zod/components'

export type Templates = {
  operations: typeof Operations.templates | false
}

INFO

Type: Templates

import { pluginZod } from '@kubb/swagger-zod'
import { Parser, File, Function } from '@kubb/react'
import { Operations } from '@kubb/swagger-zod/components'
import React from 'react'

export const templates = {
  ...Operations.templates,
} as const

const plugin = pluginZod({
  templates: {
    operations: templates,
  },
})

Example

import { defineConfig } from '@kubb/core'
import { pluginOas } from '@kubb/plugin-oas'
import { pluginZod } from '@kubb/swagger-zod'

export default defineConfig({
  input: {
    path: './petStore.yaml',
  },
  output: {
    path: './src/gen',
  },
  plugins: [
    pluginOas(),
    pluginZod({
      output: {
        path: './zod',
      },
      group: { type: 'tag', output: './schemas/{{tag}}Schemas' },
      typed: true,
      dateType: 'stringOffset',
      unknownType: 'unknown',
    }),
  ],
})

Links

• Zod