Hey API

https://heyapi.dev
Admin
Hey API generates production-ready TypeScript SDKs and validators from OpenAPI specifications, with...
Tokens:105,293
Snippets:1,270
Trust Score:8
Update:1 week ago
Show doc for...
Tokens:
Raw
### Configure moduleName and setupName for SDK examples

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Configure moduleName and setupName to make examples more practical. The example imports from the specified package and instantiates the SDK once.

```ts
import { PetStore } from '@petstore/client';


const client = new PetStore();


await client.addPet();
```

```js
export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    {
      examples: {
        moduleName: '@petstore/client',
        setupName: 'client',
      },
      name: '@hey-api/sdk',
      operations: {
        containerName: 'PetStore',
        strategy: 'single',
      },
    },
  ],
};
```

--------------------------------

### Enable SDK examples with default settings

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Enable the SDK plugin's examples option with default settings. The example shows a basic SDK call, and the config enables example generation.

```ts
import { PetStore } from 'your-package';


await new PetStore().addPet();
```

```js
export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    {
      examples: true,
      name: '@hey-api/sdk',
      operations: {
        containerName: 'PetStore',
        strategy: 'single',
      },
    },
  ],
};
```

--------------------------------

### Customize SDK initialization with importSetup

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Use importSetup to control SDK initialization with an API key. The example shows passing an apiKey to the constructor, and the config defines the setup code.

```ts
import { PetStore } from '@petstore/client';


const client = new PetStore({
  apiKey: 'YOUR_API_KEY',
});


await client.addPet();
```

```js
export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    {
      examples: {
        importSetup: ({ $, node }) =>
          $.new(
            node.name,
            $.object()
              .pretty()
              .prop('apiKey', $.literal('YOUR_API_KEY')),
          ),
        moduleName: '@petstore/client',
        setupName: 'client',
      },
      name: '@hey-api/sdk',
      operations: {
        containerName: 'PetStore',
        strategy: 'single',
      },
    },
  ],
};
```

--------------------------------

### Install @hey-api/nuxt with bun

Source: https://heyapi.dev/docs/openapi/typescript/clients/nuxt

Install the Nuxt client package using bun.

```sh
bun add @hey-api/nuxt
```

--------------------------------

### Check example code with pnpm examples:check

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Run this command before committing to ensure all generated example code is up-to-date. It regenerates all example code, checks if any files were modified, and exits with an error if generated code is out of sync. This check is also run automatically in CI.

```sh
pnpm examples:check
```

--------------------------------

### Install @hey-api/nuxt with npm

Source: https://heyapi.dev/docs/openapi/typescript/clients/nuxt

Install the Nuxt client package using npm.

```sh
npm install @hey-api/nuxt
```

--------------------------------

### Install @hey-api/nuxt with yarn

Source: https://heyapi.dev/docs/openapi/typescript/clients/nuxt

Install the Nuxt client package using yarn.

```sh
yarn add @hey-api/nuxt
```

--------------------------------

### Install @hey-api/nuxt with pnpm

Source: https://heyapi.dev/docs/openapi/typescript/clients/nuxt

Install the Nuxt client package using pnpm.

```sh
pnpm add @hey-api/nuxt
```

--------------------------------

### Python SDK create_order example

Source: https://heyapi.dev/codegen/openapi/typescript

Example of using the generated Python SDK client to create an order. Handles error and success cases.

```python
from client import Client, CreateOrderData


client = Client()


order, error = client.create_order(CreateOrderData(
    symbol='AAPL',
    side='buy',
    type='limit',
    quantity=10,
    price=189.50,
))


if error:
    print(f'Order failed: {error.message}')
else:
    print(f'Order placed: {order.id}')
```

--------------------------------

### SDK auth example and config

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Shows how to configure authentication for the SDK. The example sets an auth function on the client instance that returns a token, and the config enables auth with the 'auth: true' option.

```ts
import { client } from './client.gen';


client.setConfig({
  auth() {
    return '<token>';
  },
});
```

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

--------------------------------

### Installation: Configure @hey-api/openapi-ts for Ky client

Source: https://heyapi.dev/docs/openapi/typescript/clients/ky

Add the Ky client to your openapi-ts configuration to generate a type-safe client. This is the setup step before generating the client from your OpenAPI spec.

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

export default defineConfig({
  client: 'ky',
  input: 'path/to/your/openapi.json',
  output: 'src/client',
});
```

--------------------------------

### Install with CLI

Source: https://heyapi.dev/docs/openapi/typescript/clients/next-js

Use the CLI command with the -c flag to specify the Next.js client plugin.

```sh
npx @hey-api/openapi-ts \
  -i hey-api/backend \
  -o src/client \
  -c @hey-api/client-next
```

--------------------------------

### Example URL with organization and project

Source: https://heyapi.dev/docs/openapi/typescript/integrations

Shows the URL format when an organization and project are created.

```plaintext
https://get.heyapi.dev/foo/bar
```

--------------------------------

### Generate client with other CLI tools

Source: https://heyapi.dev/docs/openapi/typescript/integrations

Placeholder example for other CLI tools that accept an input URL and output path.

```sh
other-cli \
  --input https://get.heyapi.dev/hey-api/backend \
  --output refer/to/other/tools/docs
```

--------------------------------

### Regenerate example code with pnpm examples:update

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Run this command after making changes to core packages that affect code generation. It finds all examples with an openapi-ts script, runs the code generator for each, and updates the generated client code.

```sh
pnpm examples:update
```

--------------------------------

### getAllMocks: Setup server with all handlers

Source: https://heyapi.dev/docs/openapi/typescript/plugins/msw

Generates handlers for all operations at once, useful for quickly setting up a mock server without manually listing each operation.

```typescript
import { setupServer } from 'msw/node';
import { getAllMocks } from './client/msw.gen';


const server = setupServer(...getAllMocks());
```

--------------------------------

### Install @hey-api/client-fetch via CLI

Source: https://heyapi.dev/docs/openapi/typescript/clients/fetch

Use the npx command with the -c flag to specify @hey-api/client-fetch as the client. This is optional because Fetch is the default client.

```shell
npx @hey-api/openapi-ts \
  -i hey-api/backend \
  -o src/client \
  -c @hey-api/client-fetch
```

--------------------------------

### SDK flat parameters example and config

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Shows the flat parameter structure that merges all parameter types into a single object. The example calls addPet with all parameters at the top level, and the config sets paramsStructure to 'flat'.

```ts
import { addPet } from './sdk.gen.ts';


await addPet({
  color: 'red',
  name: 'Fluffy',
  petId: 1234,
  type: 'cat',
});
```

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

--------------------------------

### Install with openapi-ts.config.ts

Source: https://heyapi.dev/docs/openapi/typescript/clients/next-js

Add '@hey-api/client-next' to the plugins array in your openapi-ts.config.ts file to generate client artifacts.

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

--------------------------------

### SDK grouped parameters example and config

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Shows the default grouped parameter structure for SDK methods. The example calls addPet with separate body, path, and query objects, and the config sets paramsStructure to 'grouped'.

```ts
import { addPet } from './sdk.gen.ts';


await addPet({
  body: {
    name: 'Fluffy',
    type: 'cat',
  },
  path: {
    petId: 1234,
  },
  query: {
    color: 'red',
  },
});
```

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

--------------------------------

### Install with npm

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/openapi-ts as a dev dependency with an exact version using npm. The -E flag pins the version, which is recommended because the package is in initial development.

```sh
npm install @hey-api/openapi-ts -D -E
```

--------------------------------

### Changeset example: new feature

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Example changeset for a new feature, using a minor bump and the plugin(zod) scope.

```md
---
"@hey-api/openapi-ts": minor
---


**plugin(zod)**: handle guid string format
```

--------------------------------

### Install with bun

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/openapi-ts as a dev dependency using bun. Note that the -E flag is not used here, unlike the other package managers.

```sh
bun add @hey-api/openapi-ts -D
```

--------------------------------

### Changeset example: plugin change

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Example changeset for a plugin change, using a patch bump and the plugin(@hey-api/client-fetch) scope.

```md
---
"@hey-api/openapi-ts": patch
---


**plugin(@hey-api/client-fetch)**: improve error handling
```

--------------------------------

### Install with yarn

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/openapi-ts as a dev dependency with an exact version using yarn. The -E flag pins the version, which is recommended because the package is in initial development.

```sh
yarn add @hey-api/openapi-ts -D -E
```

--------------------------------

### Configure @hey-api/sdk plugin with examples

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Configure the @hey-api/sdk plugin with the examples option to generate a default payload for the addPet() method. The payload function returns a default payload for operations matching the /pet/{petId} or /pet paths.

```js
export default {
  input: 'hey-api/backend', // sign up at app.heyapi.dev
  output: 'src/client',
  plugins: [
    // ...other plugins
    {
      examples: {
        importKind: 'default',
        importName: 'CatStore',
        importSetup: ({ $, node }) =>
          $.new(
            node.name,
            $.object()
              .pretty()
              .prop('apiKey', $.literal('YOUR_API_KEY')),
          ),
        moduleName: '@petstore/client',
        payload(operation, ctx) {
          const { $ } = ctx;
          if (operation.path === '/pet/{petId}' || operation.path === '/pet') {
            return $.object().pretty().prop('petId', $.literal(1234));
          }
        },
        setupName: 'client',
      },
      // ...other plugins
    ],
  };
```

--------------------------------

### Generated Fastify route handlers example

Source: https://heyapi.dev/docs/openapi/typescript/plugins/fastify

Generated Fastify route handlers for the example endpoints. The handlers use the naming convention of SDK functions and are registered with the glue plugin.

```ts
const fastify = Fastify();
const serviceHandlers: RouteHandlers = {
  createPets(request, reply) {
    reply.code(201).send();
  },
  listPets(request, reply) {
    reply.code(200).send([]);
  },
  showPetById(request, reply) {
    reply.code(200).send({
      id: Number(request.params.petId),
      name: 'Kitty',
    });
  },
};
fastify.register(glue, { serviceHandlers });
```

--------------------------------

### Instance strategy example (sdk.gen.ts)

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Generated SDK file when operations.strategy is set to 'single'. The SDK is a class that extends HeyApiClient, with methods for each operation.

```ts
import type { AddPetData } from './types.gen';


export class Sdk extends HeyApiClient {
  public addPet(options: Options<AddPetData>) {
    /** ... */
  }
}

```

--------------------------------

### Install with pnpm

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/openapi-ts as a dev dependency with an exact version using pnpm. The -E flag pins the version, which is recommended because the package is in initial development.

```sh
pnpm add @hey-api/openapi-ts -D -E
```

--------------------------------

### Install @hey-api/client-fetch via config file

Source: https://heyapi.dev/docs/openapi/typescript/clients/fetch

Add @hey-api/client-fetch to the plugins array in your openapi-ts.config.ts file. This is optional because Fetch is the default client.

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

--------------------------------

### Configure openapi-ts with @hey-api/client-ofetch plugin

Source: https://heyapi.dev/docs/openapi/typescript/clients/ofetch

Adds the ofetch client plugin to the openapi-ts configuration file. This is the recommended installation method.

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

--------------------------------

### Python client create_order

Source: https://heyapi.dev/codegen/openapi/python

Example of using the generated Python client to create an order and handle errors.

```python
from client import Client, CreateOrderData


client = Client()


order, error = client.create_order(CreateOrderData(
    symbol='AAPL',
    side='buy',
    type='limit',
    quantity=10,
    price=189.50,
))


if error:
    print(f'Order failed: {error.message}')
else:
    print(f'Order placed: {order.id}')

```

--------------------------------

### Flat strategy example (sdk.gen.ts)

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Generated SDK file when operations.strategy is set to 'flat'. The SDK exports a standalone function for each operation, supporting tree-shaking.

```ts
import type { AddPetData } from './types.gen';


export const addPet = (options: Options<AddPetData>) => {
  /** ... */
};

```

--------------------------------

### Custom SDK class name example (sdk.gen.ts)

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Generated SDK file when operations.containerName is set to 'PetStore'. The class is renamed from the default 'Sdk'.

```ts
import { client } from './client.gen';
import type { AddPetData, AddPetErrors, AddPetResponses } from './types.gen';


export class PetStore extends HeyApiClient {
  /** ... */
}

```

--------------------------------

### Install @hey-api/vite-plugin with npm, pnpm, yarn, or bun

Source: https://heyapi.dev/docs/openapi/typescript/configuration/vite

Install the @hey-api/vite-plugin package using your preferred package manager. The npm, pnpm, and yarn commands use the -D -E flags to save as a dev dependency and pin the exact version, while the bun command uses -D only.

```sh
npm install @hey-api/vite-plugin -D -E
```

```sh
pnpm add @hey-api/vite-plugin -D -E
```

```sh
yarn add @hey-api/vite-plugin -D -E
```

```sh
bun add @hey-api/vite-plugin -D
```

--------------------------------

### Install @hey-api/transformers plugin

Source: https://heyapi.dev/docs/openapi/typescript/plugins/transformers

Adds the '@hey-api/transformers' plugin to the Hey API configuration to enable transformer generation.

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

--------------------------------

### Call createOrder SDK

Source: https://heyapi.dev/codegen/openapi/python

Example of calling the generated SDK function createOrder and handling the response.

```typescript
import { createOrder } from './sdk.gen';


const { data, error } = await createOrder({
  symbol: 'AAPL',
  side: 'buy',
  type: 'limit',
  quantity: 10,
  price: 189.5,
});


if (error) {
  console.error('Order failed:', error.message);
  return;
}


console.log('Order placed:', data.id);

```

--------------------------------

### setConfig() with baseURL in src/index.ts

Source: https://heyapi.dev/docs/openapi/typescript/clients/axios

Call setConfig() at the start of your application or whenever you need to update the client configuration. Pass any Axios configuration option except 'auth'. The example sets the baseURL to https://example.com.

```javascript
import { client } from 'client/client.gen';


client.setConfig({
  baseURL: 'https://example.com',
});
```

--------------------------------

### Use response examples as defaults

Source: https://heyapi.dev/docs/openapi/typescript/plugins/msw

When the OpenAPI spec includes response examples, generated handlers use them as defaults. Calling the handler without arguments returns the example response automatically; you can still override with a custom response.

```ts
import { getFooMock } from './client/msw.gen';


const mockServer = setupServer(
  // uses the example response from the OpenAPI spec as default
  getFooMock(),


  // you can still override with a custom response
  getFooMock({ result: { name: 'Custom' } }),
);
```

--------------------------------

### Install HTTPX client via CLI

Source: https://heyapi.dev/docs/openapi/python/clients/httpx

Use the npx command with the -c flag to specify the HTTPX client plugin. This is optional because HTTPX is the default client.

```shell
npx @hey-api/openapi-python \
  -i hey-api/backend \
  -o src/client \
  -c @hey-api/client-httpx
```

--------------------------------

### Generated request function example

Source: https://heyapi.dev/docs/openapi/typescript/plugins/angular

Example of a generated request function for an endpoint, returning an HttpRequest result.

```typescript
export const addPetRequest = (options) =>
  client.requestOptions({
    method: 'POST',
    responseStyle: 'data',
    url: '/pet',
    ...options,
  });

```

--------------------------------

### Generated resource function example

Source: https://heyapi.dev/docs/openapi/typescript/plugins/angular

Example of a generated resource function for an endpoint, returning a result from an httpResource call.

```typescript
export const addPetResource = (options) => httpResource(() => addPetRequest(options()));

```

--------------------------------

### Configure default client with createClient() before v0.52.0

Source: https://heyapi.dev/docs/openapi/typescript/migrating

Before v0.52.0, client packages created a default client that you imported and configured with createClient(). This example shows the old way of configuring the client.

```javascript
import { client, createClient } from '@hey-api/client-fetch';


createClient({
  baseUrl: 'https://example.com',
});


console.log(client.getConfig().baseUrl); // <-- 'https://example.com'
```

--------------------------------

### Changeset example: bug fix

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Example changeset for a bug fix, using a patch bump and the parser scope.

```md
---
"@hey-api/openapi-ts": patch
---


**parser**: fix explicit discriminator mapping
```

--------------------------------

### Changeset example: breaking change

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Example changeset for a breaking change, using a minor bump and the BREAKING prefix in the description.

```md
---
"@hey-api/openapi-ts": minor
---


**BREAKING**: removed deprecated `getClient()` function
```

--------------------------------

### Changeset format example

Source: https://heyapi.dev/docs/openapi/typescript/community/contributing/developing

Shows the standard format for a changeset file. The frontmatter specifies the package and semver bump type, followed by a summary with a scope and description.

```md
---
"@hey-api/openapi-ts": patch
---


**scope**: description of changes
```

--------------------------------

### Generate client programmatically with createClient()

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Generates output programmatically by calling createClient() in a JavaScript/TypeScript file. The input and output options mirror the CLI flags from Quick Start.

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


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

--------------------------------

### Generate ofetch client via CLI

Source: https://heyapi.dev/docs/openapi/typescript/clients/ofetch

Installs the ofetch client using the openapi-ts CLI with the -c flag. This is an alternative to the configuration file method.

```sh
npx @hey-api/openapi-ts \
  -i hey-api/backend \
  -o src/client \
  -c @hey-api/client-ofetch
```

--------------------------------

### Install @hey-api/vite-plugin with bun

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/vite-plugin as a dev dependency using bun. This plugin integrates @hey-api/openapi-ts into Vite 5, 6, 7, or 8 build pipelines.

```sh
bun add @hey-api/vite-plugin -D
```

--------------------------------

### Custom SDK structure example (sdk.gen.ts)

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Generated SDK file when operations.nesting is customized. The addPet method is renamed to pet.add and nested inside a Pet class.

```ts
import { client } from './client.gen';
import type { AddPetData, AddPetErrors, AddPetResponses } from './types.gen';


export class Pet extends HeyApiClient {
  public add(options: Options<PostPetData>) {
    /** ... */
  }
}


export class PetStore extends HeyApiClient {
  get pet(): Pet {
    /** ... */
  }
}

```

--------------------------------

### Mutation example: react-query.gen.ts

Source: https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query

Shows the generated mutation function using useMutation with the addPetMutation() SDK function. The example calls addPet.mutate() with a body containing the pet name 'Kitty'.

```ts
const addPet = useMutation({
  ...addPetMutation(),
  onError: (error) => {
    console.log(error);
  },
});


addPet.mutate({
  body: {
    name: 'Kitty',
  },
});
```

--------------------------------

### Disable response examples in MSW plugin config

Source: https://heyapi.dev/docs/openapi/typescript/plugins/msw

Configuration to disable embedding OpenAPI examples in the generated output. By default, source is set to ['@hey-api/examples']; set it to an empty array to disable.

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

--------------------------------

### Usage example: PetsController implementing generated methods

Source: https://heyapi.dev/docs/openapi/typescript/plugins/nest

Example controller that implements the generated PetsControllerMethods. It uses NestJS decorators to map HTTP methods and parameters to the type-safe method signatures.

```ts
import { Body, Controller, Get, Param, Post, Query } from '@nestjs/common';


import type { PetsControllerMethods } from '../client/nestjs.gen';
import type { CreatePetData, ListPetsData, ShowPetByIdData } from '../client/types.gen';


@Controller('pets')
export class PetsController implements Pick<
  PetsControllerMethods,
  'createPet' | 'listPets' | 'showPetById'
> {
  @Post()
  async createPet(@Body() body: CreatePetData['body']) {}


  @Get()
  async listPets(@Query() query?: ListPetsData['query']) {}


  @Get(':petId')
  async showPetById(@Param() path: ShowPetByIdData['path']) {}
}
```

--------------------------------

### Install HTTPX client via config file

Source: https://heyapi.dev/docs/openapi/python/clients/httpx

Add '@hey-api/client-httpx' to the plugins array in your openapi-python.config.ts file to generate client artifacts. This is optional because HTTPX is the default client.

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

--------------------------------

### Install @hey-api/vite-plugin with yarn

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/vite-plugin as a dev dependency with an exact version using yarn. This plugin integrates @hey-api/openapi-ts into Vite 5, 6, 7, or 8 build pipelines.

```sh
yarn add @hey-api/vite-plugin -D -E
```

--------------------------------

### Infinite Queries: useInfiniteQuery with getFooInfiniteOptions and config

Source: https://heyapi.dev/docs/openapi/typescript/plugins/tanstack-query

Shows how to use the generated `getFooInfiniteOptions()` function with `useInfiniteQuery` and how to enable `infiniteQueryOptions` in the plugin configuration. The config sets `infiniteQueryOptions: true` to generate infinite query options.

```ts
const query = useInfiniteQuery({
  ...getFooInfiniteOptions({
    path: {
      fooId: 1,
    },
  }),
  getNextPageParam: (lastPage, pages) => lastPage.nextCursor,
  initialPageParam: 0,
});
```

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

--------------------------------

### Install @hey-api/vite-plugin with pnpm

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/vite-plugin as a dev dependency with an exact version using pnpm. This plugin integrates @hey-api/openapi-ts into Vite 5, 6, 7, or 8 build pipelines.

```sh
pnpm add @hey-api/vite-plugin -D -E
```

--------------------------------

### Install @hey-api/vite-plugin with npm

Source: https://heyapi.dev/docs/openapi/typescript/get-started

Installs @hey-api/vite-plugin as a dev dependency with an exact version using npm. This plugin integrates @hey-api/openapi-ts into Vite 5, 6, 7, or 8 build pipelines.

```sh
npm install @hey-api/vite-plugin -D -E
```

--------------------------------

### Migrate to useOptions: true with old and new client imports

Source: https://heyapi.dev/docs/openapi/typescript/migrating

Shows how to import the old and new clients when migrating to the default `useOptions: true` behavior. The old client uses array arguments, while the new client uses a single options object. This allows gradual migration by deprecating the old client and generating a new one.

```typescript
import { DefaultService } from 'client/services'; // <-- old client with array arguments


import { DefaultService } from 'client_v2/services'; // <-- new client with options argument
```

--------------------------------

### Customize example request with payload option (TypeScript)

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Shows a default payload for the addPet() method using the payload option. The example creates a CatStore client with an API key and calls addPet() with a petId.

```ts
import CatStore from '@petstore/client';


const client = new CatStore({
  apiKey: 'YOUR_API_KEY',
});


await client.addPet({
  petId: 1234,
});
```

--------------------------------

### Configure client with setConfig() from services after v0.52.0

Source: https://heyapi.dev/docs/openapi/typescript/migrating

Starting with v0.52.0, client packages no longer create a default client. Instead, services define their own client, and you configure it by importing client from services and using the new setConfig() method.

```javascript
import { client } from 'client/services.gen';


client.setConfig({
  baseUrl: 'https://example.com',
});


console.log(client.getConfig().baseUrl); // <-- 'https://example.com'
```

--------------------------------

### Generate client with CLI using @hey-api/client-nuxt

Source: https://heyapi.dev/docs/openapi/typescript/clients/nuxt

Use the openapi-ts CLI with the -c flag to specify the client plugin.

```sh
npx @hey-api/openapi-ts \
  -i hey-api/backend \
  -o src/client \
  -c @hey-api/client-nuxt
```

--------------------------------

### SDK transformer example (sdk.gen.ts)

Source: https://heyapi.dev/docs/openapi/typescript/plugins/sdk

Shows how to define a response transformer in the generated SDK. The transformer option is used instead of validator, and applies to responses only. The example uses valibot's parseAsync to validate the response data.

```typescript
import * as v from 'valibot';


export const addPet = (options: Options<AddPetData>) =>
  (options.client ?? client).post<AddPetResponses, AddPetErrors>({
    responseTransformer: async (data) =>
      await v.parseAsync(vAddPetResponse, data),
    /** ... */
  });
```

--------------------------------

### Using generated mutation with useMutation

Source: https://heyapi.dev/docs/openapi/typescript/plugins/pinia-colada

Shows the generated mutation function `addPetMutation()` used inside Pinia Colada's `useMutation`. The `onError` callback logs errors, and `mutate` is called with a body containing a `name` property. This example is from the `example` section of the Mutations documentation.

```ts
const addPet = useMutation({
  ...addPetMutation(),
  onError: (error) => {
    console.log(error);
  },
});


addPet.mutate({
  body: {
    name: 'Kitty',
  },
});

```
Tokens:
Raw