Options#

Options for @kubb/plugin-axios, which generates a type-safe HTTP client pinned to axios.

output#

Where the generated .ts files are written and how they are exported.

output.path#

Folder where the plugin writes its files, defaulting to 'clients' and resolved against the global output.path on defineConfig. For a single file, set output.mode: 'file' and give path a name with its extension, such as 'clients.ts'.

output.mode#

'file' writes everything into a single file whose output.path must include the extension. 'directory' writes one file per operation under output.path. Leave it unset and Kubb reads output.path: a name with an extension means one file, anything else a directory.

output.barrel#

output.banner#

output.footer#

group#

group.name#

Function (context: { group: string }) => string that turns a group key into a folder name and wins over the default, which camelCases the tag or uses the first path segment.

baseURL#

Base URL prepended to every request. When omitted, no host is prepended and each request uses the operation's relative path from the spec, with no server-URL fallback. A value containing a ${...} interpolation is emitted as a template literal, so baseURL: '${process.env.API_URL}' reads the environment variable at runtime.

validator#

Validates request and response bodies with schemas from @kubb/plugin-zod, which you add to the plugins list when either direction is 'zod'. false (the default) skips validation and returns the response cast to the generated type. 'zod' validates the success response body, plus the error body when a non-2xx call does not throw. { request?: 'zod', response?: 'zod' } opts in per direction, and with validation on the generated function throws a ParseError on invalid data.

comments#

How much of each OpenAPI description reaches the JSDoc above each generated operation. Defaults to 'full', which emits every description in full, however many paragraphs the spec carries. 'brief' keeps the opening sentence and leaves every other tag such as @summary and the {@link} in place, cutting a description that runs on for 150 characters without a sentence ending at the last word before 120. 'none' emits no JSDoc, leaving the generated-by banner untouched. Descriptions are a third of the output on a large spec, so pick 'brief' or 'none' when file size matters more than editor hovers.

sdk#

Generates a class-based SDK instead of standalone functions, where each tag client is an instance class whose constructor takes a client config and builds its own client, so every environment is a separate instance. mode: 'tag' (the default) emits one class per tag such as PetClient and StoreClient. Add sdk.name to also emit a composed root that instantiates every tag client from one shared config, reached as new PetStore(config).pet.getPetById(...). mode: 'flat' emits a single class named by sdk.name with every operation as a direct method. Leave sdk unset to keep the per-operation functions the query plugins consume.

Construct a class with a ClientConfig (baseURL, headers, and so on), then call a method with the grouped options object ({ path, query, headers, body }) and read data off the result.

import { PetClient } from './src/gen/clients/petClient'

const pet = new PetClient({ baseURL: 'https://petstore.swagger.io/v2' })
const { data } = await pet.getPetById({ path: { petId: 1 } })

Each call resolves to { status, data, error, contentType, request, response }. Because throwOnError defaults to true, a resolved call means the request succeeded and data is set. Pass throwOnError: false to get the discriminated union instead, keyed on the top-level status.

const { status, data, error } = await pet.getPetById({ path: { petId: 1 }, throwOnError: false })

if (status === 200) {
  console.log(data) // data is the success body, error is undefined
} else {
  console.error(status, error) // status is the documented error code, error is its parsed body
}

returnType#

Shape of the value a generated call resolves to. 'full' (the default) keeps { status, data, error, contentType, request, response }. 'data' unwraps that down to the bare success body once throwOnError (on by default) rules out the error branch, and falls back to the full result for a call that sets throwOnError: false, since that path still needs error to tell success from failure.

pluginAxios({ returnType: 'data' })

const pet = await getPetById({ path: { petId: 1 } }) // Pet, not { status, data, ... }

This applies to the standalone functions and the class-based SDK. It does not apply to @kubb/plugin-react-query, @kubb/plugin-vue-query, or @kubb/plugin-swr, which call the client directly and expect the full result.

include#

exclude#

override#

resolver#

Changes how the plugin names generated files and symbols. Pass a partial patch. Override only the members you want, and anything you omit keeps resolverClient. See Override a resolver for the this context and how a patch layers over the default.

type ResolverClientPatch = {
  name?(name: string): string
  file?: {
    baseName?(params: { name: string; extname: string }): string
    path?(params: { baseName: string; output: Output }): string
  }
  className?(name: string): string
  groupName?(name: string): string // → 'PetClient'
  propertyName?(name: string): string
}

macros#