About​

Valibot is the open source schema library for TypeScript with bundle size, type safety and developer experience in mind.

The Valibot plugin for Hey API generates schemas from your OpenAPI spec, fully compatible with validators, transformers, and all core features.

Features​

• Valibot v1 support
• seamless integration with@hey-api/openapi-ts ecosystem
• Valibot schemas for requests, responses, and reusable definitions
• minimal learning curve thanks to extending the underlying technology

Installation​

In yourconfiguration, addvalibot to your plugins and you'll be ready to generate Valibot artifacts. 🎉

export default {  input:'hey-api/backend',// sign up at app.heyapi.dev  output:'src/client',  plugins: [    // ...other plugins    'valibot',  ],};

SDKs​

To add data validators to your SDKs, setsdk.validator totrue.

export default {  input:'hey-api/backend',// sign up at app.heyapi.dev  output:'src/client',  plugins: [    // ...other plugins    'valibot',    {      name:'@hey-api/sdk',      validator:true,    },  ],};

Learn more about data validators in your SDKs on theSDKs page.

Output​

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

Requests​

A single request schema is generated for each endpoint. It may contain a request body, parameters, and headers.

const vData = v.object({  body: v.optional(    v.object({      foo: v.optional(v.string()),      bar: v.optional(v.union([v.number(), v.null()])),    }),  ),  path: v.object({    baz: v.string(),  }),  query: v.optional(v.never()),});

export default {  input:'hey-api/backend',// sign up at app.heyapi.dev  output:'src/client',  plugins: [    // ...other plugins    {      name:'valibot',      requests:true,    },  ],};

You can customize the naming and casing pattern forrequests schemas using the.name and.case options.

Responses​

A single Valibot 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 vResponse = v.union([  v.object({    foo: v.optional(v.string()),  }),  v.object({    bar: v.optional(v.number()),  }),]);

export default {  input:'hey-api/backend',// sign up at app.heyapi.dev  output:'src/client',  plugins: [    // ...other plugins    {      name:'valibot',      responses:true,    },  ],};

You can customize the naming and casing pattern forresponses schemas using the.name and.case options.

Definitions​

A Valibot schema is generated for every reusable definition from your input.

const vFoo = v.pipe(v.number(), v.integer());const vBar = v.object({  bar: v.optional(v.array(v.pipe(v.number(), v.integer()))),});

export default {  input:'hey-api/backend',// sign up at app.heyapi.dev  output:'src/client',  plugins: [    // ...other plugins    {      name:'valibot',      definitions:true,    },  ],};

You can customize the naming and casing pattern fordefinitions schemas using the.name and.case options.

Metadata​

It's often useful to associate a schema with some additionalmetadata for documentation, code generation, AI structured outputs, form validation, and other purposes. If this is your use case, you can setmetadata totrue to generate additional metadata about schemas.

export const vFoo = v.pipe(  v.string(),  v.metadata({    description:'Additional metadata',  }),);

export default {  input:'hey-api/backend',// sign up at app.heyapi.dev  output:'src/client',  plugins: [    // ...other plugins    {      name:'valibot',      metadata:true,    },  ],};

Resolvers​

You can further customize this plugin's behavior usingresolvers.

API​

You can view the complete list of options in theUserConfig interface.

Examples​

You can view live examples onStackBlitz.

Sponsors​

Hey API is sponsor-funded. If you rely on Hey API in production, consider becoming asponsor to accelerate the roadmap.