@kubb/plugin-axios

Generate typed API calls with Axios.

• One async function per OpenAPI operation.
• Grouped request parameters and status-keyed results.

Installation

bun add -d @kubb/plugin-axios

pnpm add -D @kubb/plugin-axios

npm install --save-dev @kubb/plugin-axios

yarn add -D @kubb/plugin-axios

Or run kubb add plugin-axios to install the version the Kubb registry pins and add pluginAxios() to kubb.config.ts.

Dependencies

• Add pluginTs or pluginZod with inferred: true for operation types. pluginTs takes precedence.
• Add pluginZod for validation.
• Install Axios v1 or higher in the consuming app.

Example

import { defineConfig } from 'kubb/config'
import { pluginTs } from '@kubb/plugin-ts'
import { pluginAxios } from '@kubb/plugin-axios'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen' },
  plugins: [
    pluginTs(),
    pluginAxios({ baseURL: 'https://petstore.swagger.io/v2' }),
  ],
})

See also

• axios
• @kubb/plugin-ts