SWR

Generates typed SWR hooks from your OpenAPI spec: useSWR for reads and useSWRMutation for writes.

The plugin ships no HTTP client. Each hook calls a function generated by a client plugin.

Installation

bun add -d @kubb/plugin-swr

pnpm add -D @kubb/plugin-swr

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

yarn add -D @kubb/plugin-swr

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

Setup

• Add @kubb/plugin-ts and a client plugin: @kubb/plugin-fetch or @kubb/plugin-axios.
• Install SWR v2 or higher in the app that uses the generated code.
• Configure validation on the client plugin, not here.

Options worth knowing

• client picks fetch or axios when both client plugins are registered. A single client is detected automatically.
• query and mutation set which HTTP methods become queries (GET) and mutations (POST, PUT, PATCH, DELETE), and where SWR is imported from (swr and swr/mutation). Set either to false to skip it.