---
title: "Valibot v1 Plugin"
description: "Generate Valibot v1 schemas from OpenAPI with the Valibot plugin for openapi-ts. Fully compatible with validators, transformers, and all core features."
url: "https://heyapi.dev/docs/openapi/typescript/plugins/valibot"
---

### About

[Section titled “About”](#about)

[Valibot](https://valibot.dev) 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

[Section titled “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

[Section titled “Installation”](#installation)

In your [configuration](https://heyapi.dev/openapi-ts/get-started), add `valibot` to your plugins and you’ll be ready to generate Valibot artifacts. 🎉

openapi-ts.config.ts

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

### SDKs

[Section titled “SDKs”](#sdks)

To add data validators to your SDKs, set `sdk.validator` to `true`.

openapi-ts.config.ts

```js
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 the [SDKs](https://heyapi.dev/openapi-ts/plugins/sdk#validators) page.

## Output

[Section titled “Output”](#output)

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

## Requests

[Section titled “Requests”](#requests)

A Valibot schema is generated for every request layer of each endpoint.

* example

  valibot.gen.ts

  ```ts
  const vDeletePetHeaders = v.object({
    api_key: v.optional(v.string()),
  });


  const vDeletePetPath = v.object({
    petId: v.number(),
  });


  const vDeletePetQuery = v.object({
    additionalMetadata: v.string(),
  });
  ```

* config

  openapi-ts.config.ts

  ```js
  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 for `requests` schemas using the `.name` and `.case` options.

## Responses

[Section titled “Responses”](#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.

* example

  valibot.gen.ts

  ```ts
  const vResponse = v.union([
    v.object({
      foo: v.optional(v.string()),
    }),
    v.object({
      bar: v.optional(v.number()),
    }),
  ]);
  ```

* config

  openapi-ts.config.ts

  ```js
  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 for `responses` schemas using the `.name` and `.case` options.

## Definitions

[Section titled “Definitions”](#definitions)

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

* example

  valibot.gen.ts

  ```ts
  const vFoo = v.pipe(v.number(), v.integer());


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

* config

  openapi-ts.config.ts

  ```js
  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 for `definitions` schemas using the `.name` and `.case` options.

## Metadata

[Section titled “Metadata”](#metadata)

It’s often useful to associate a schema with some additional [metadata](https://valibot.dev/api/metadata/) for documentation, code generation, AI structured outputs, form validation, and other purposes. You can set `metadata` to `true` to attach descriptions to schemas when available.

* example

  valibot.gen.ts

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

* config

  openapi-ts.config.ts

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

For more control over metadata, you can provide your own function. It receives the source `schema`, the target `node` object, and the `$` builder for populating metadata.

* example

  valibot.gen.ts

  ```ts
  export const vFoo = v.pipe(
    v.string(),
    v.metadata({
      hasTitle: false,
      createdAt: 1735732800000,
    }),
  );
  ```

* config

  openapi-ts.config.ts

  ```js
  export default {
    input: 'hey-api/backend', // sign up at app.heyapi.dev
    output: 'src/client',
    plugins: [
      // ...other plugins
      {
        name: 'valibot',
        metadata({ $, node, schema }) {
          node.prop('hasTitle', $.literal(Boolean(schema.title)));
          node.prop('createdAt', $.literal(Date.now()));
        },
      },
    ],
  };
  ```

## Resolvers

[Section titled “Resolvers”](#resolvers)

You can further customize this plugin’s behavior using [resolvers](https://heyapi.dev/openapi-ts/plugins/concepts/resolvers).

## API

[Section titled “API”](#api)

You can view the complete list of options in the [UserConfig](https://github.com/hey-api/openapi-ts/blob/main/packages/openapi-ts/src/plugins/valibot/types.ts) interface.

## Examples

You can view live examples on [StackBlitz](https://stackblitz.com/orgs/github/hey-api/collections/openapi-ts-examples) or on [GitHub](https://github.com/hey-api/openapi-ts/tree/main/examples).