Configuration

@hey-api/openapi-ts supports loading configuration from any file inside your project root folder supported by jiti loader. Below are the most common file formats.

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

export default defineConfig({
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
});

/** @type {import('@hey-api/openapi-ts').UserConfig} */
module.exports = {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
};

/** @type {import('@hey-api/openapi-ts').UserConfig} */
export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
};

Alternatively, you can use openapi-ts.config.js and configure the export statement depending on your project setup.

Input

You must provide an input so we can load your OpenAPI specification.

The input can be a string path, URL, API registry shorthand, an object containing any of these, or an object representing an OpenAPI specification. Hey API supports all valid OpenAPI versions and file formats.

You can learn more on the Input page.

export default {
  input: './path/to/openapi.json',
};

export default {
  input: 'https://get.heyapi.dev/hey-api/backend', // sign up at app.heyapi.dev
};

export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
};

export default {
  input: {
    path: 'hey-api/backend', // sign up at app.heyapi.dev
    // ...other options
  },
};

export default {
  input: {
    openapi: '3.1.1',
    // ...rest of your spec
  },
};

Output

You must set the output so we know where to generate your files. It can be a path to the destination folder or an object containing the destination folder path and optional settings.

You can learn more on the Output page.

path
object

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

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

Parser

We parse your input before making it available to plugins. Configuring the parser is optional, but it provides an ideal opportunity to modify or validate your input as needed.

You can learn more on the Parser page.

Plugins

Plugins are responsible for generating artifacts from your input. By default, Hey API will generate TypeScript interfaces and SDK from your OpenAPI specification. You can add, remove, or customize any of the plugins. In fact, we highly encourage you to do so!

You can learn more on the Output page.

Advanced

More complex configuration scenarios can be handled by providing an array of inputs, outputs, or configurations.

Multiple jobs

Throughout this documentation, we generally reference single job configurations. However, you can easily run multiple jobs by providing an array of configuration objects.

config
example

export default [
  {
    input: 'foo.yaml',
    output: 'src/foo',
  },
  {
    input: 'bar.yaml',
    output: 'src/bar',
  },
];

Job matrix

Reusing configuration across multiple jobs is possible by defining a job matrix. You can create a job matrix by providing input and output arrays of matching length.

config
example

export default {
  input: ['foo.yaml', 'bar.yaml'],
  output: ['src/foo', 'src/bar'],
};

Merging inputs

You can merge inputs by defining multiple inputs and a single output.

config
example

export default {
  input: ['foo.yaml', 'bar.yaml'],
  output: 'src/client',
};

API

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

Examples

You can view live examples on StackBlitz or on GitHub.