Kubb@kubb/swagger-zod 🦙 ​
With the Swagger Zod plugin you can use Zod to validate your schema's based on a Swagger file.
Installation ​
shell
bun add @kubb/swagger-zod @kubb/swaggerbun add @kubb/swagger-zod @kubb/swaggershell
pnpm add @kubb/swagger-zod @kubb/swaggerpnpm add @kubb/swagger-zod @kubb/swaggershell
npm install @kubb/swagger-zod @kubb/swaggernpm install @kubb/swagger-zod @kubb/swaggershell
yarn add @kubb/swagger-zod @kubb/swaggeryarn add @kubb/swagger-zod @kubb/swaggerOptions ​
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'
typescript
import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
output: './zod',
},
),
],
})import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
output: './zod',
},
),
],
})groupBy ​
Group the Zod schemas based on the provided name.
type ​
Tag will group based on the operation tag inside the Swagger file.
Type: 'tag'
Required: true
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'
exportAs ​
Name to be used for the export * as {{exportAs}} from './
Type: string
Default: '{{tag}}Schemas'
INFO
typescript
import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
output: './schemas',
groupBy: { type: 'tag', output: './schemas/{{tag}}Schemas' },
},
),
],
})import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
output: './schemas',
groupBy: { type: 'tag', output: './schemas/{{tag}}Schemas' },
},
),
],
})skipBy ​
Array containing skipBy paramaters to exclude/skip tags/operations/methods/paths.
type
typescript
export type SkipBy = {
type: 'tag' | 'operationId' | 'path' | 'method'
pattern: string | RegExp
}export type SkipBy = {
type: 'tag' | 'operationId' | 'path' | 'method'
pattern: string | RegExp
}INFO
Type: Array<SkipBy>
typescript
import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
skipBy: [
{
type: 'tag',
pattern: 'store',
},
],
},
),
],
})import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
skipBy: [
{
type: 'tag',
pattern: 'store',
},
],
},
),
],
})overrideBy ​
Array containing overrideBy paramaters to override options based on tags/operations/methods/paths.
type
typescript
export type OverrideBy = {
type: 'tag' | 'operationId' | 'path' | 'method'
pattern: string | RegExp
options: PluginOptions
}export type OverrideBy = {
type: 'tag' | 'operationId' | 'path' | 'method'
pattern: string | RegExp
options: PluginOptions
}INFO
Type: Array<OverrideBy>
typescript
import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerTS({}),
createSwaggerZod(
{
overrideBy: [
{
type: 'tag',
pattern: 'pet',
options: {
output: './custom',
},
},
],
},
),
],
})import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerTS({}),
createSwaggerZod(
{
overrideBy: [
{
type: 'tag',
pattern: 'pet',
options: {
output: './custom',
},
},
],
},
),
],
})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) => string
typescript
import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
transformers: {
name: (name) => {
return `${name}Client`
},
},
},
),
],
})import { defineConfig } from '@kubb/swagger'
import createSwagger from '@kubb/swagger'
import createSwaggerZod from '@kubb/swagger-zod'
export default defineConfig({
input: {
path: './petStore.yaml',
},
output: {
path: './src/gen',
},
plugins: [
createSwagger({ output: false }),
createSwaggerZod(
{
transformers: {
name: (name) => {
return `${name}Client`
},
},
},
),
],
})