Axios
Officialv5.5.11@kubb/plugin-axios
Set the base URL
Set baseURL on the client plugin or on the generated client.
server option of adapterOas only sets document metadata. It does not set baseURL.Use the baseURL option
Pass baseURL to pluginAxios to set the generated default. Add pluginTs for the operation types.
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://localhost:8080/api/v1' }),
],
})A value containing a ${...} interpolation stays dynamic. The plugin emits it as a template literal in the generated client config, so baseURL: '${process.env.API_URL}' reads the environment variable when the app runs instead of baking in the build-time value.
Set it at runtime
Use client.setConfig to configure all operations at startup:
import { client } from './gen/.kubb/client'
client.setConfig({ baseURL: import.meta.env.VITE_API_URL })Use createClient for an isolated client, then pass it to an operation:
import { createClient } from './gen/.kubb/client'
import { getPetById } from './gen/clients/getPetById'
const staging = createClient({ baseURL: 'https://staging.petstore.swagger.io/v2' })
const { data } = await getPetById({ path: { petId: 1 }, client: staging })Pass baseURL on a single call to override the client for that one request:
import { getPetById } from './gen/clients/getPetById'
const { data } = await getPetById({ path: { petId: 1 }, baseURL: 'https://localhost:3000' })A baseURL set on the call wins over createClient, which wins over setConfig, which wins over the build-time value.
See also
Authenticate requests
Set an auth resolver on the generated client. Operations use the security schemes declared in your OpenAPI spec. Requests remain unauthenticated until you provide credentials.
Call operations
The generated client accepts grouped request options on every operation and returns a typed RequestResult by default.